« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 294
- compare with another revision
- download diff
- download tarball
- view history from revision 294
- Committer: Martin Pool
- Date: 2005-04-28 07:24:55 UTC
- Revision ID: mbp@sourcefrog.net-20050428072453-7b99afa993a1e549
todo
- files added:
- bzrlib/remotebranch.py
- files removed:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/store
- bzrlib/transport
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files renamed:
- contrib/newinventory.py => bzrlib/newinventory.py
- bzrlib/store/__init__.py => bzrlib/store.py
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/util/urlgrabber/ => urlgrabber/
- 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
19
import os
20
import errno
21
from warnings import warn
22
from cStringIO import StringIO
18
from sets import Set
23
19
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
import traceback, socket, fnmatch, difflib, time
22
from binascii import hexlify
24
23
25
24
import bzrlib
26
from bzrlib.inventory import InventoryEntry
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes,
30
rename, splitpath, sha_file, appendpath,
31
file_kind, abspath)
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError)
37
from bzrlib.textui import show_status
38
from bzrlib.revision import Revision, is_ancestor, get_intervening_revisions
39
40
from bzrlib.delta import compare_trees
41
from bzrlib.tree import EmptyTree, RevisionTree
42
from bzrlib.inventory import Inventory
43
from bzrlib.store import copy_all
44
from bzrlib.store.compressed_text import CompressedTextStore
45
from bzrlib.store.text import TextStore
46
from bzrlib.store.weave import WeaveStore
47
from bzrlib.testament import Testament
48
import bzrlib.transactions as transactions
49
from bzrlib.transport import Transport, get_transport
50
import bzrlib.xml5
51
import bzrlib.ui
52
53
54
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
55
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
56
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
25
from inventory import Inventory
26
from trace import mutter, note
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
from inventory import InventoryEntry, Inventory
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
joinpath, sha_string, file_kind, local_time_offset, appendpath
32
from store import ImmutableStore
33
from revision import Revision
34
from errors import bailout, BzrError
35
from textui import show_status
36
from diff import diff_trees
37
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
57
39
## TODO: Maybe include checks for common corruption of newlines, etc?
58
40
59
41
60
# TODO: Some operations like log might retrieve the same revisions
61
# repeatedly to calculate deltas. We could perhaps have a weakref
62
# cache in memory to make this faster. In general anything can be
63
# cached in memory between lock and unlock operations.
64
65
def find_branch(*ignored, **ignored_too):
66
# XXX: leave this here for about one release, then remove it
67
raise NotImplementedError('find_branch() is not supported anymore, '
68
'please use one of the new branch constructors')
69
70
71
def needs_read_lock(unbound):
72
"""Decorate unbound to take out and release a read lock."""
73
def decorated(self, *args, **kwargs):
74
self.lock_read()
75
try:
76
return unbound(self, *args, **kwargs)
77
finally:
78
self.unlock()
79
return decorated
80
81
82
def needs_write_lock(unbound):
83
"""Decorate unbound to take out and release a write lock."""
84
def decorated(self, *args, **kwargs):
85
self.lock_write()
86
try:
87
return unbound(self, *args, **kwargs)
88
finally:
89
self.unlock()
90
return decorated
42
43
def find_branch_root(f=None):
44
"""Find the branch root enclosing f, or pwd.
45
46
It is not necessary that f exists.
47
48
Basically we keep looking up until we find the control directory or
49
run into the root."""
50
if f == None:
51
f = os.getcwd()
52
elif hasattr(os.path, 'realpath'):
53
f = os.path.realpath(f)
54
else:
55
f = os.path.abspath(f)
56
57
orig_f = f
58
59
while True:
60
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
61
return f
62
head, tail = os.path.split(f)
63
if head == f:
64
# reached the root, whatever that may be
65
raise BzrError('%r is not in a branch' % orig_f)
66
f = head
67
68
91
69
92
70
######################################################################
93
71
# branch objects
94
72
95
class Branch(object):
73
class Branch:
96
74
"""Branch holding a history of revisions.
97
75
98
base
99
Base directory/url of the branch.
100
"""
101
base = None
102
103
def __init__(self, *ignored, **ignored_too):
104
raise NotImplementedError('The Branch class is abstract')
105
106
@staticmethod
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format.
109
110
Only local branches are supported."""
111
return _Branch(get_transport(base), relax_version_check=True)
112
113
@staticmethod
114
def open(base):
115
"""Open an existing branch, rooted at 'base' (url)"""
116
t = get_transport(base)
117
mutter("trying to open %r with transport %r", base, t)
118
return _Branch(t)
119
120
@staticmethod
121
def open_containing(url):
122
"""Open an existing branch which contains url.
123
124
This probes for a branch at url, and searches upwards from there.
125
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one, it is returned, along with the unused portion of url.
129
"""
130
t = get_transport(url)
131
while True:
132
try:
133
return _Branch(t), t.relpath(url)
134
except NotBranchError:
135
pass
136
new_t = t.clone('..')
137
if new_t.base == t.base:
138
# reached the root, whatever that may be
139
raise NotBranchError(path=url)
140
t = new_t
141
142
@staticmethod
143
def initialize(base):
144
"""Create a new branch, rooted at 'base' (url)"""
145
t = get_transport(base)
146
return _Branch(t, init=True)
147
148
def setup_caching(self, cache_root):
149
"""Subclasses that care about caching should override this, and set
150
up cached stores located under cache_root.
151
"""
152
self.cache_root = cache_root
153
154
155
class _Branch(Branch):
156
"""A branch stored in the actual filesystem.
157
158
Note that it's "local" in the context of the filesystem; it doesn't
159
really matter if it's on an nfs/smb/afs/coda/... share, as long as
160
it's writable, and can be accessed via the normal filesystem API.
161
162
_lock_mode
163
None, or 'r' or 'w'
164
165
_lock_count
166
If _lock_mode is true, a positive count of the number of times the
167
lock has been taken.
168
169
_lock
170
Lock object from bzrlib.lock.
171
"""
172
# We actually expect this class to be somewhat short-lived; part of its
173
# purpose is to try to isolate what bits of the branch logic are tied to
174
# filesystem access, so that in a later step, we can extricate them to
175
# a separarte ("storage") class.
176
_lock_mode = None
177
_lock_count = None
178
_lock = None
179
_inventory_weave = None
180
181
# Map some sort of prefix into a namespace
182
# stuff like "revno:10", "revid:", etc.
183
# This should match a prefix with a function which accepts
184
REVISION_NAMESPACES = {}
185
186
def push_stores(self, branch_to):
187
"""Copy the content of this branches store to branch_to."""
188
if (self._branch_format != branch_to._branch_format
189
or self._branch_format != 4):
190
from bzrlib.fetch import greedy_fetch
191
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
192
self, self._branch_format, branch_to, branch_to._branch_format)
193
greedy_fetch(to_branch=branch_to, from_branch=self,
194
revision=self.last_revision())
195
return
196
197
store_pairs = ((self.text_store, branch_to.text_store),
198
(self.inventory_store, branch_to.inventory_store),
199
(self.revision_store, branch_to.revision_store))
200
try:
201
for from_store, to_store in store_pairs:
202
copy_all(from_store, to_store)
203
except UnlistableStore:
204
raise UnlistableBranch(from_store)
205
206
def __init__(self, transport, init=False,
207
relax_version_check=False):
76
TODO: Perhaps use different stores for different classes of object,
77
so that we can keep track of how much space each one uses,
78
or garbage-collect them.
79
80
TODO: Add a RemoteBranch subclass. For the basic case of read-only
81
HTTP access this should be very easy by,
82
just redirecting controlfile access into HTTP requests.
83
We would need a RemoteStore working similarly.
84
85
TODO: Keep the on-disk branch locked while the object exists.
86
87
TODO: mkdir() method.
88
"""
89
def __init__(self, base, init=False, find_root=True):
208
90
"""Create new branch object at a particular location.
209
91
210
transport -- A Transport object, defining how to access files.
211
(If a string, transport.transport() will be used to
212
create a Transport object)
92
base -- Base directory for the branch.
213
93
214
94
init -- If True, create new control files in a previously
215
95
unversioned directory. If False, the branch must already
216
96
be versioned.
217
97
218
relax_version_check -- If true, the usual check for the branch
219
version is not applied. This is intended only for
220
upgrade/recovery type use; it's not guaranteed that
221
all operations will work on old format branches.
98
find_root -- If true and init is false, find the root of the
99
existing branch containing base.
222
100
223
101
In the test suite, creation of new trees is tested using the
224
102
`ScratchBranch` class.
225
103
"""
226
assert isinstance(transport, Transport), \
227
"%r is not a Transport" % transport
228
self._transport = transport
229
104
if init:
105
self.base = os.path.realpath(base)
230
106
self._make_control()
231
self._check_format(relax_version_check)
232
233
def get_store(name, compressed=True, prefixed=False):
234
# FIXME: This approach of assuming stores are all entirely compressed
235
# or entirely uncompressed is tidy, but breaks upgrade from
236
# some existing branches where there's a mixture; we probably
237
# still want the option to look for both.
238
relpath = self._rel_controlfilename(name)
239
if compressed:
240
store = CompressedTextStore(self._transport.clone(relpath),
241
prefixed=prefixed)
242
else:
243
store = TextStore(self._transport.clone(relpath),
244
prefixed=prefixed)
245
#if self._transport.should_cache():
246
# cache_path = os.path.join(self.cache_root, name)
247
# os.mkdir(cache_path)
248
# store = bzrlib.store.CachedStore(store, cache_path)
249
return store
250
def get_weave(name, prefixed=False):
251
relpath = self._rel_controlfilename(name)
252
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
253
if self._transport.should_cache():
254
ws.enable_cache = True
255
return ws
256
257
if self._branch_format == 4:
258
self.inventory_store = get_store('inventory-store')
259
self.text_store = get_store('text-store')
260
self.revision_store = get_store('revision-store')
261
elif self._branch_format == 5:
262
self.control_weaves = get_weave('')
263
self.weave_store = get_weave('weaves')
264
self.revision_store = get_store('revision-store', compressed=False)
265
elif self._branch_format == 6:
266
self.control_weaves = get_weave('')
267
self.weave_store = get_weave('weaves', prefixed=True)
268
self.revision_store = get_store('revision-store', compressed=False,
269
prefixed=True)
270
self.revision_store.register_suffix('sig')
271
self._transaction = None
107
elif find_root:
108
self.base = find_branch_root(base)
109
else:
110
self.base = os.path.realpath(base)
111
if not isdir(self.controlfilename('.')):
112
bailout("not a bzr branch: %s" % quotefn(base),
113
['use "bzr init" to initialize a new working tree',
114
'current bzr can only operate from top-of-tree'])
115
self._check_format()
116
117
self.text_store = ImmutableStore(self.controlfilename('text-store'))
118
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
119
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
120
272
121
273
122
def __str__(self):
274
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
123
return '%s(%r)' % (self.__class__.__name__, self.base)
275
124
276
125
277
126
__repr__ = __str__
278
127
279
128
280
def __del__(self):
281
if self._lock_mode or self._lock:
282
# XXX: This should show something every time, and be suitable for
283
# headless operation and embedding
284
warn("branch %r was not explicitly unlocked" % self)
285
self._lock.unlock()
286
287
# TODO: It might be best to do this somewhere else,
288
# but it is nice for a Branch object to automatically
289
# cache it's information.
290
# Alternatively, we could have the Transport objects cache requests
291
# See the earlier discussion about how major objects (like Branch)
292
# should never expect their __del__ function to run.
293
if hasattr(self, 'cache_root') and self.cache_root is not None:
294
try:
295
import shutil
296
shutil.rmtree(self.cache_root)
297
except:
298
pass
299
self.cache_root = None
300
301
def _get_base(self):
302
if self._transport:
303
return self._transport.base
304
return None
305
306
base = property(_get_base, doc="The URL for the root of this branch.")
307
308
def _finish_transaction(self):
309
"""Exit the current transaction."""
310
if self._transaction is None:
311
raise errors.LockError('Branch %s is not in a transaction' %
312
self)
313
transaction = self._transaction
314
self._transaction = None
315
transaction.finish()
316
317
def get_transaction(self):
318
"""Return the current active transaction.
319
320
If no transaction is active, this returns a passthrough object
321
for which all data is immedaitely flushed and no caching happens.
322
"""
323
if self._transaction is None:
324
return transactions.PassThroughTransaction()
325
else:
326
return self._transaction
327
328
def _set_transaction(self, new_transaction):
329
"""Set a new active transaction."""
330
if self._transaction is not None:
331
raise errors.LockError('Branch %s is in a transaction already.' %
332
self)
333
self._transaction = new_transaction
334
335
def lock_write(self):
336
mutter("lock write: %s (%s)", self, self._lock_count)
337
# TODO: Upgrade locking to support using a Transport,
338
# and potentially a remote locking protocol
339
if self._lock_mode:
340
if self._lock_mode != 'w':
341
raise LockError("can't upgrade to a write lock from %r" %
342
self._lock_mode)
343
self._lock_count += 1
344
else:
345
self._lock = self._transport.lock_write(
346
self._rel_controlfilename('branch-lock'))
347
self._lock_mode = 'w'
348
self._lock_count = 1
349
self._set_transaction(transactions.PassThroughTransaction())
350
351
def lock_read(self):
352
mutter("lock read: %s (%s)", self, self._lock_count)
353
if self._lock_mode:
354
assert self._lock_mode in ('r', 'w'), \
355
"invalid lock mode %r" % self._lock_mode
356
self._lock_count += 1
357
else:
358
self._lock = self._transport.lock_read(
359
self._rel_controlfilename('branch-lock'))
360
self._lock_mode = 'r'
361
self._lock_count = 1
362
self._set_transaction(transactions.ReadOnlyTransaction())
363
# 5K may be excessive, but hey, its a knob.
364
self.get_transaction().set_cache_size(5000)
365
366
def unlock(self):
367
mutter("unlock: %s (%s)", self, self._lock_count)
368
if not self._lock_mode:
369
raise LockError('branch %r is not locked' % (self))
370
371
if self._lock_count > 1:
372
self._lock_count -= 1
373
else:
374
self._finish_transaction()
375
self._lock.unlock()
376
self._lock = None
377
self._lock_mode = self._lock_count = None
378
379
129
def abspath(self, name):
380
"""Return absolute filename for something in the branch
381
382
XXX: Robert Collins 20051017 what is this used for? why is it a branch
383
method and not a tree method.
384
"""
385
return self._transport.abspath(name)
386
387
def _rel_controlfilename(self, file_or_path):
388
if not isinstance(file_or_path, basestring):
389
file_or_path = '/'.join(file_or_path)
390
if file_or_path == '':
391
return bzrlib.BZRDIR
392
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
130
"""Return absolute filename for something in the branch"""
131
return os.path.join(self.base, name)
132
133
134
def relpath(self, path):
135
"""Return path relative to this branch of something inside it.
136
137
Raises an error if path is not in this branch."""
138
rp = os.path.realpath(path)
139
# FIXME: windows
140
if not rp.startswith(self.base):
141
bailout("path %r is not within branch %r" % (rp, self.base))
142
rp = rp[len(self.base):]
143
rp = rp.lstrip(os.sep)
144
return rp
145
393
146
394
147
def controlfilename(self, file_or_path):
395
148
"""Return location relative to branch."""
396
return self._transport.abspath(self._rel_controlfilename(file_or_path))
149
if isinstance(file_or_path, types.StringTypes):
150
file_or_path = [file_or_path]
151
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
397
152
398
153
399
154
def controlfile(self, file_or_path, mode='r'):
403
158
and binary. binary files are untranslated byte streams. Text
404
159
control files are stored with Unix newlines and in UTF-8, even
405
160
if the platform or locale defaults are different.
406
407
Controlfiles should almost never be opened in write mode but
408
rather should be atomically copied and replaced using atomicfile.
409
161
"""
410
import codecs
411
412
relpath = self._rel_controlfilename(file_or_path)
413
#TODO: codecs.open() buffers linewise, so it was overloaded with
414
# a much larger buffer, do we need to do the same for getreader/getwriter?
415
if mode == 'rb':
416
return self._transport.get(relpath)
417
elif mode == 'wb':
418
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
419
elif mode == 'r':
420
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
421
elif mode == 'w':
422
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
162
163
fn = self.controlfilename(file_or_path)
164
165
if mode == 'rb' or mode == 'wb':
166
return file(fn, mode)
167
elif mode == 'r' or mode == 'w':
168
# open in binary mode anyhow so there's no newline translation;
169
# codecs uses line buffering by default; don't want that.
170
import codecs
171
return codecs.open(fn, mode + 'b', 'utf-8',
172
buffering=60000)
423
173
else:
424
174
raise BzrError("invalid controlfile mode %r" % mode)
425
175
426
def put_controlfile(self, path, f, encode=True):
427
"""Write an entry as a controlfile.
428
429
:param path: The path to put the file, relative to the .bzr control
430
directory
431
:param f: A file-like or string object whose contents should be copied.
432
:param encode: If true, encode the contents as utf-8
433
"""
434
self.put_controlfiles([(path, f)], encode=encode)
435
436
def put_controlfiles(self, files, encode=True):
437
"""Write several entries as controlfiles.
438
439
:param files: A list of [(path, file)] pairs, where the path is the directory
440
underneath the bzr control directory
441
:param encode: If true, encode the contents as utf-8
442
"""
443
import codecs
444
ctrl_files = []
445
for path, f in files:
446
if encode:
447
if isinstance(f, basestring):
448
f = f.encode('utf-8', 'replace')
449
else:
450
f = codecs.getwriter('utf-8')(f, errors='replace')
451
path = self._rel_controlfilename(path)
452
ctrl_files.append((path, f))
453
self._transport.put_multi(ctrl_files)
176
454
177
455
178
def _make_control(self):
456
from bzrlib.inventory import Inventory
457
from bzrlib.weavefile import write_weave_v5
458
from bzrlib.weave import Weave
459
460
# Create an empty inventory
461
sio = StringIO()
462
# if we want per-tree root ids then this is the place to set
463
# them; they're not needed for now and so ommitted for
464
# simplicity.
465
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
466
empty_inv = sio.getvalue()
467
sio = StringIO()
468
bzrlib.weavefile.write_weave_v5(Weave(), sio)
469
empty_weave = sio.getvalue()
470
471
dirs = [[], 'revision-store', 'weaves']
472
files = [('README',
179
os.mkdir(self.controlfilename([]))
180
self.controlfile('README', 'w').write(
473
181
"This is a Bazaar-NG control directory.\n"
474
"Do not change any files in this directory.\n"),
475
('branch-format', BZR_BRANCH_FORMAT_6),
476
('revision-history', ''),
477
('branch-name', ''),
478
('branch-lock', ''),
479
('pending-merges', ''),
480
('inventory', empty_inv),
481
('inventory.weave', empty_weave),
482
('ancestry.weave', empty_weave)
483
]
484
cfn = self._rel_controlfilename
485
self._transport.mkdir_multi([cfn(d) for d in dirs])
486
self.put_controlfiles(files)
487
mutter('created control directory in ' + self._transport.base)
488
489
def _check_format(self, relax_version_check):
182
"Do not change any files in this directory.")
183
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
184
for d in ('text-store', 'inventory-store', 'revision-store'):
185
os.mkdir(self.controlfilename(d))
186
for f in ('revision-history', 'merged-patches',
187
'pending-merged-patches', 'branch-name'):
188
self.controlfile(f, 'w').write('')
189
mutter('created control directory in ' + self.base)
190
Inventory().write_xml(self.controlfile('inventory','w'))
191
192
193
def _check_format(self):
490
194
"""Check this branch format is supported.
491
195
492
The format level is stored, as an integer, in
493
self._branch_format for code that needs to check it later.
196
The current tool only supports the current unstable format.
494
197
495
198
In the future, we might need different in-memory Branch
496
199
classes to support downlevel branches. But not yet.
497
200
"""
498
try:
499
fmt = self.controlfile('branch-format', 'r').read()
500
except NoSuchFile:
501
raise NotBranchError(path=self.base)
502
mutter("got branch format %r", fmt)
503
if fmt == BZR_BRANCH_FORMAT_6:
504
self._branch_format = 6
505
elif fmt == BZR_BRANCH_FORMAT_5:
506
self._branch_format = 5
507
elif fmt == BZR_BRANCH_FORMAT_4:
508
self._branch_format = 4
509
510
if (not relax_version_check
511
and self._branch_format not in (5, 6)):
512
raise errors.UnsupportedFormatError(
513
'sorry, branch format %r not supported' % fmt,
514
['use a different bzr version',
515
'or remove the .bzr directory'
516
' and "bzr init" again'])
517
518
def get_root_id(self):
519
"""Return the id of this branches root"""
520
inv = self.read_working_inventory()
521
return inv.root.file_id
522
523
def set_root_id(self, file_id):
524
inv = self.read_working_inventory()
525
orig_root_id = inv.root.file_id
526
del inv._byid[inv.root.file_id]
527
inv.root.file_id = file_id
528
inv._byid[inv.root.file_id] = inv.root
529
for fid in inv:
530
entry = inv[fid]
531
if entry.parent_id in (None, orig_root_id):
532
entry.parent_id = inv.root.file_id
533
self._write_inventory(inv)
534
535
@needs_read_lock
201
# This ignores newlines so that we can open branches created
202
# on Windows from Linux and so on. I think it might be better
203
# to always make all internal files in unix format.
204
fmt = self.controlfile('branch-format', 'r').read()
205
fmt.replace('\r\n', '')
206
if fmt != BZR_BRANCH_FORMAT:
207
bailout('sorry, branch format %r not supported' % fmt,
208
['use a different bzr version',
209
'or remove the .bzr directory and "bzr init" again'])
210
211
536
212
def read_working_inventory(self):
537
213
"""Read the working inventory."""
214
before = time.time()
538
215
# ElementTree does its own conversion from UTF-8, so open in
539
216
# binary.
540
f = self.controlfile('inventory', 'rb')
541
return bzrlib.xml5.serializer_v5.read_inventory(f)
542
543
@needs_write_lock
217
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
218
mutter("loaded inventory of %d items in %f"
219
% (len(inv), time.time() - before))
220
return inv
221
222
544
223
def _write_inventory(self, inv):
545
224
"""Update the working inventory.
546
225
547
226
That is to say, the inventory describing changes underway, that
548
227
will be committed to the next revision.
549
228
"""
550
from cStringIO import StringIO
551
sio = StringIO()
552
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
553
sio.seek(0)
554
# Transport handles atomicity
555
self.put_controlfile('inventory', sio)
556
229
## TODO: factor out to atomicfile? is rename safe on windows?
230
## TODO: Maybe some kind of clean/dirty marker on inventory?
231
tmpfname = self.controlfilename('inventory.tmp')
232
tmpf = file(tmpfname, 'wb')
233
inv.write_xml(tmpf)
234
tmpf.close()
235
inv_fname = self.controlfilename('inventory')
236
if sys.platform == 'win32':
237
os.remove(inv_fname)
238
os.rename(tmpfname, inv_fname)
557
239
mutter('wrote working inventory')
558
240
241
559
242
inventory = property(read_working_inventory, _write_inventory, None,
560
243
"""Inventory for the working copy.""")
561
244
562
@needs_write_lock
563
def add(self, files, ids=None):
245
246
def add(self, files, verbose=False):
564
247
"""Make files versioned.
565
248
566
Note that the command line normally calls smart_add instead,
567
which can automatically recurse.
249
Note that the command line normally calls smart_add instead.
568
250
569
251
This puts the files in the Added state, so that they will be
570
252
recorded by the next commit.
571
253
572
files
573
List of paths to add, relative to the base of the tree.
574
575
ids
576
If set, use these instead of automatically generated ids.
577
Must be the same length as the list of files, but may
578
contain None for ids that are to be autogenerated.
579
580
254
TODO: Perhaps have an option to add the ids even if the files do
581
not (yet) exist.
582
583
TODO: Perhaps yield the ids and paths as they're added.
255
not (yet) exist.
256
257
TODO: Perhaps return the ids of the files? But then again it
258
is easy to retrieve them if they're needed.
259
260
TODO: Option to specify file id.
261
262
TODO: Adding a directory should optionally recurse down and
263
add all non-ignored children. Perhaps do that in a
264
higher-level method.
265
266
>>> b = ScratchBranch(files=['foo'])
267
>>> 'foo' in b.unknowns()
268
True
269
>>> b.show_status()
270
? foo
271
>>> b.add('foo')
272
>>> 'foo' in b.unknowns()
273
False
274
>>> bool(b.inventory.path2id('foo'))
275
True
276
>>> b.show_status()
277
A foo
278
279
>>> b.add('foo')
280
Traceback (most recent call last):
281
...
282
BzrError: ('foo is already versioned', [])
283
284
>>> b.add(['nothere'])
285
Traceback (most recent call last):
286
BzrError: ('cannot add: not a regular file or directory: nothere', [])
584
287
"""
288
585
289
# TODO: Re-adding a file that is removed in the working copy
586
290
# should probably put it back with the previous ID.
587
if isinstance(files, basestring):
588
assert(ids is None or isinstance(ids, basestring))
291
if isinstance(files, types.StringTypes):
589
292
files = [files]
590
if ids is not None:
591
ids = [ids]
592
593
if ids is None:
594
ids = [None] * len(files)
595
else:
596
assert(len(ids) == len(files))
597
293
598
294
inv = self.read_working_inventory()
599
for f,file_id in zip(files, ids):
295
for f in files:
600
296
if is_control_file(f):
601
raise BzrError("cannot add control file %s" % quotefn(f))
297
bailout("cannot add control file %s" % quotefn(f))
602
298
603
299
fp = splitpath(f)
604
300
605
301
if len(fp) == 0:
606
raise BzrError("cannot add top-level %r" % f)
607
302
bailout("cannot add top-level %r" % f)
303
608
304
fullpath = os.path.normpath(self.abspath(f))
609
305
610
306
try:
611
307
kind = file_kind(fullpath)
612
308
except OSError:
613
309
# maybe something better?
614
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
615
616
if not InventoryEntry.versionable_kind(kind):
617
raise BzrError('cannot add: not a versionable file ('
618
'i.e. regular file, symlink or directory): %s' % quotefn(f))
619
620
if file_id is None:
621
file_id = gen_file_id(f)
310
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
311
312
if kind != 'file' and kind != 'directory':
313
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
314
315
file_id = gen_file_id(f)
622
316
inv.add_path(f, kind=kind, file_id=file_id)
623
317
318
if verbose:
319
show_status('A', kind, quotefn(f))
320
624
321
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
625
322
626
323
self._write_inventory(inv)
627
324
628
@needs_read_lock
325
629
326
def print_file(self, file, revno):
630
327
"""Print `file` to stdout."""
631
tree = self.revision_tree(self.get_rev_id(revno))
328
tree = self.revision_tree(self.lookup_revision(revno))
632
329
# use inventory as it was in that revision
633
330
file_id = tree.inventory.path2id(file)
634
331
if not file_id:
635
raise BzrError("%r is not present in revision %s" % (file, revno))
332
bailout("%r is not present in revision %d" % (file, revno))
636
333
tree.print_file(file_id)
637
638
# FIXME: this doesn't need to be a branch method
639
def set_inventory(self, new_inventory_list):
640
from bzrlib.inventory import Inventory, InventoryEntry
641
inv = Inventory(self.get_root_id())
642
for path, file_id, parent, kind in new_inventory_list:
643
name = os.path.basename(path)
644
if name == "":
645
continue
646
# fixme, there should be a factory function inv,add_??
647
if kind == 'directory':
648
inv.add(inventory.InventoryDirectory(file_id, name, parent))
649
elif kind == 'file':
650
inv.add(inventory.InventoryFile(file_id, name, parent))
651
elif kind == 'symlink':
652
inv.add(inventory.InventoryLink(file_id, name, parent))
653
else:
654
raise BzrError("unknown kind %r" % kind)
334
335
336
def remove(self, files, verbose=False):
337
"""Mark nominated files for removal from the inventory.
338
339
This does not remove their text. This does not run on
340
341
TODO: Refuse to remove modified files unless --force is given?
342
343
>>> b = ScratchBranch(files=['foo'])
344
>>> b.add('foo')
345
>>> b.inventory.has_filename('foo')
346
True
347
>>> b.remove('foo')
348
>>> b.working_tree().has_filename('foo')
349
True
350
>>> b.inventory.has_filename('foo')
351
False
352
353
>>> b = ScratchBranch(files=['foo'])
354
>>> b.add('foo')
355
>>> b.commit('one')
356
>>> b.remove('foo')
357
>>> b.commit('two')
358
>>> b.inventory.has_filename('foo')
359
False
360
>>> b.basis_tree().has_filename('foo')
361
False
362
>>> b.working_tree().has_filename('foo')
363
True
364
365
TODO: Do something useful with directories.
366
367
TODO: Should this remove the text or not? Tough call; not
368
removing may be useful and the user can just use use rm, and
369
is the opposite of add. Removing it is consistent with most
370
other tools. Maybe an option.
371
"""
372
## TODO: Normalize names
373
## TODO: Remove nested loops; better scalability
374
375
if isinstance(files, types.StringTypes):
376
files = [files]
377
378
tree = self.working_tree()
379
inv = tree.inventory
380
381
# do this before any modifications
382
for f in files:
383
fid = inv.path2id(f)
384
if not fid:
385
bailout("cannot remove unversioned file %s" % quotefn(f))
386
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
387
if verbose:
388
# having remove it, it must be either ignored or unknown
389
if tree.is_ignored(f):
390
new_status = 'I'
391
else:
392
new_status = '?'
393
show_status(new_status, inv[fid].kind, quotefn(f))
394
del inv[fid]
395
655
396
self._write_inventory(inv)
656
397
398
657
399
def unknowns(self):
658
400
"""Return all unknown files.
659
401
660
402
These are files in the working directory that are not versioned or
661
403
control files or ignored.
662
404
663
>>> from bzrlib.workingtree import WorkingTree
664
405
>>> b = ScratchBranch(files=['foo', 'foo~'])
665
>>> map(str, b.unknowns())
406
>>> list(b.unknowns())
666
407
['foo']
667
408
>>> b.add('foo')
668
409
>>> list(b.unknowns())
669
410
[]
670
>>> WorkingTree(b.base, b).remove('foo')
411
>>> b.remove('foo')
671
412
>>> list(b.unknowns())
672
[u'foo']
413
['foo']
673
414
"""
674
415
return self.working_tree().unknowns()
675
416
676
@needs_write_lock
677
def append_revision(self, *revision_ids):
678
for revision_id in revision_ids:
679
mutter("add {%s} to revision-history" % revision_id)
417
418
def commit(self, message, timestamp=None, timezone=None,
419
committer=None,
420
verbose=False):
421
"""Commit working copy as a new revision.
422
423
The basic approach is to add all the file texts into the
424
store, then the inventory, then make a new revision pointing
425
to that inventory and store that.
426
427
This is not quite safe if the working copy changes during the
428
commit; for the moment that is simply not allowed. A better
429
approach is to make a temporary copy of the files before
430
computing their hashes, and then add those hashes in turn to
431
the inventory. This should mean at least that there are no
432
broken hash pointers. There is no way we can get a snapshot
433
of the whole directory at an instant. This would also have to
434
be robust against files disappearing, moving, etc. So the
435
whole thing is a bit hard.
436
437
timestamp -- if not None, seconds-since-epoch for a
438
postdated/predated commit.
439
"""
440
441
## TODO: Show branch names
442
443
# TODO: Don't commit if there are no changes, unless forced?
444
445
# First walk over the working inventory; and both update that
446
# and also build a new revision inventory. The revision
447
# inventory needs to hold the text-id, sha1 and size of the
448
# actual file versions committed in the revision. (These are
449
# not present in the working inventory.) We also need to
450
# detect missing/deleted files, and remove them from the
451
# working inventory.
452
453
work_inv = self.read_working_inventory()
454
inv = Inventory()
455
basis = self.basis_tree()
456
basis_inv = basis.inventory
457
missing_ids = []
458
for path, entry in work_inv.iter_entries():
459
## TODO: Cope with files that have gone missing.
460
461
## TODO: Check that the file kind has not changed from the previous
462
## revision of this file (if any).
463
464
entry = entry.copy()
465
466
p = self.abspath(path)
467
file_id = entry.file_id
468
mutter('commit prep file %s, id %r ' % (p, file_id))
469
470
if not os.path.exists(p):
471
mutter(" file is missing, removing from inventory")
472
if verbose:
473
show_status('D', entry.kind, quotefn(path))
474
missing_ids.append(file_id)
475
continue
476
477
# TODO: Handle files that have been deleted
478
479
# TODO: Maybe a special case for empty files? Seems a
480
# waste to store them many times.
481
482
inv.add(entry)
483
484
if basis_inv.has_id(file_id):
485
old_kind = basis_inv[file_id].kind
486
if old_kind != entry.kind:
487
bailout("entry %r changed kind from %r to %r"
488
% (file_id, old_kind, entry.kind))
489
490
if entry.kind == 'directory':
491
if not isdir(p):
492
bailout("%s is entered as directory but not a directory" % quotefn(p))
493
elif entry.kind == 'file':
494
if not isfile(p):
495
bailout("%s is entered as file but is not a file" % quotefn(p))
496
497
content = file(p, 'rb').read()
498
499
entry.text_sha1 = sha_string(content)
500
entry.text_size = len(content)
501
502
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
503
if (old_ie
504
and (old_ie.text_size == entry.text_size)
505
and (old_ie.text_sha1 == entry.text_sha1)):
506
## assert content == basis.get_file(file_id).read()
507
entry.text_id = basis_inv[file_id].text_id
508
mutter(' unchanged from previous text_id {%s}' %
509
entry.text_id)
510
511
else:
512
entry.text_id = gen_file_id(entry.name)
513
self.text_store.add(content, entry.text_id)
514
mutter(' stored with text_id {%s}' % entry.text_id)
515
if verbose:
516
if not old_ie:
517
state = 'A'
518
elif (old_ie.name == entry.name
519
and old_ie.parent_id == entry.parent_id):
520
state = 'M'
521
else:
522
state = 'R'
523
524
show_status(state, entry.kind, quotefn(path))
525
526
for file_id in missing_ids:
527
# have to do this later so we don't mess up the iterator.
528
# since parents may be removed before their children we
529
# have to test.
530
531
# FIXME: There's probably a better way to do this; perhaps
532
# the workingtree should know how to filter itself.
533
if work_inv.has_id(file_id):
534
del work_inv[file_id]
535
536
537
inv_id = rev_id = _gen_revision_id(time.time())
538
539
inv_tmp = tempfile.TemporaryFile()
540
inv.write_xml(inv_tmp)
541
inv_tmp.seek(0)
542
self.inventory_store.add(inv_tmp, inv_id)
543
mutter('new inventory_id is {%s}' % inv_id)
544
545
self._write_inventory(work_inv)
546
547
if timestamp == None:
548
timestamp = time.time()
549
550
if committer == None:
551
committer = username()
552
553
if timezone == None:
554
timezone = local_time_offset()
555
556
mutter("building commit log message")
557
rev = Revision(timestamp=timestamp,
558
timezone=timezone,
559
committer=committer,
560
precursor = self.last_patch(),
561
message = message,
562
inventory_id=inv_id,
563
revision_id=rev_id)
564
565
rev_tmp = tempfile.TemporaryFile()
566
rev.write_xml(rev_tmp)
567
rev_tmp.seek(0)
568
self.revision_store.add(rev_tmp, rev_id)
569
mutter("new revision_id is {%s}" % rev_id)
570
571
## XXX: Everything up to here can simply be orphaned if we abort
572
## the commit; it will leave junk files behind but that doesn't
573
## matter.
574
575
## TODO: Read back the just-generated changeset, and make sure it
576
## applies and recreates the right state.
577
578
## TODO: Also calculate and store the inventory SHA1
579
mutter("committing patch r%d" % (self.revno() + 1))
580
581
582
self.append_revision(rev_id)
583
584
if verbose:
585
note("commited r%d" % self.revno())
586
587
588
def append_revision(self, revision_id):
589
mutter("add {%s} to revision-history" % revision_id)
680
590
rev_history = self.revision_history()
681
rev_history.extend(revision_ids)
682
self.set_revision_history(rev_history)
683
684
@needs_write_lock
685
def set_revision_history(self, rev_history):
686
self.put_controlfile('revision-history', '\n'.join(rev_history))
687
688
def has_revision(self, revision_id):
689
"""True if this branch has a copy of the revision.
690
691
This does not necessarily imply the revision is merge
692
or on the mainline."""
693
return (revision_id is None
694
or self.revision_store.has_id(revision_id))
695
696
@needs_read_lock
697
def get_revision_xml_file(self, revision_id):
698
"""Return XML file object for revision object."""
699
if not revision_id or not isinstance(revision_id, basestring):
700
raise InvalidRevisionId(revision_id)
701
try:
702
return self.revision_store.get(revision_id)
703
except (IndexError, KeyError):
704
raise bzrlib.errors.NoSuchRevision(self, revision_id)
705
706
#deprecated
707
get_revision_xml = get_revision_xml_file
708
709
def get_revision_xml(self, revision_id):
710
return self.get_revision_xml_file(revision_id).read()
591
592
tmprhname = self.controlfilename('revision-history.tmp')
593
rhname = self.controlfilename('revision-history')
594
595
f = file(tmprhname, 'wt')
596
rev_history.append(revision_id)
597
f.write('\n'.join(rev_history))
598
f.write('\n')
599
f.close()
600
601
if sys.platform == 'win32':
602
os.remove(rhname)
603
os.rename(tmprhname, rhname)
604
711
605
712
606
713
607
def get_revision(self, revision_id):
714
608
"""Return the Revision object for a named revision"""
715
xml_file = self.get_revision_xml_file(revision_id)
716
717
try:
718
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
719
except SyntaxError, e:
720
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
721
[revision_id,
722
str(e)])
723
609
r = Revision.read_xml(self.revision_store[revision_id])
724
610
assert r.revision_id == revision_id
725
611
return r
726
612
727
def get_revision_delta(self, revno):
728
"""Return the delta for one revision.
729
730
The delta is relative to its mainline predecessor, or the
731
empty tree for revision 1.
732
"""
733
assert isinstance(revno, int)
734
rh = self.revision_history()
735
if not (1 <= revno <= len(rh)):
736
raise InvalidRevisionNumber(revno)
737
738
# revno is 1-based; list is 0-based
739
740
new_tree = self.revision_tree(rh[revno-1])
741
if revno == 1:
742
old_tree = EmptyTree()
743
else:
744
old_tree = self.revision_tree(rh[revno-2])
745
746
return compare_trees(old_tree, new_tree)
747
748
def get_revision_sha1(self, revision_id):
749
"""Hash the stored value of a revision, and return it."""
750
# In the future, revision entries will be signed. At that
751
# point, it is probably best *not* to include the signature
752
# in the revision hash. Because that lets you re-sign
753
# the revision, (add signatures/remove signatures) and still
754
# have all hash pointers stay consistent.
755
# But for now, just hash the contents.
756
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
757
758
def get_ancestry(self, revision_id):
759
"""Return a list of revision-ids integrated by a revision.
760
761
This currently returns a list, but the ordering is not guaranteed:
762
treat it as a set.
763
"""
764
if revision_id is None:
765
return [None]
766
w = self.get_inventory_weave()
767
return [None] + map(w.idx_to_name,
768
w.inclusions([w.lookup(revision_id)]))
769
770
def get_inventory_weave(self):
771
return self.control_weaves.get_weave('inventory',
772
self.get_transaction())
773
774
def get_inventory(self, revision_id):
775
"""Get Inventory object by hash."""
776
xml = self.get_inventory_xml(revision_id)
777
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
778
779
def get_inventory_xml(self, revision_id):
780
"""Get inventory XML as a file object."""
781
try:
782
assert isinstance(revision_id, basestring), type(revision_id)
783
iw = self.get_inventory_weave()
784
return iw.get_text(iw.lookup(revision_id))
785
except IndexError:
786
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
787
788
def get_inventory_sha1(self, revision_id):
789
"""Return the sha1 hash of the inventory entry
790
"""
791
return self.get_revision(revision_id).inventory_sha1
613
614
def get_inventory(self, inventory_id):
615
"""Get Inventory object by hash.
616
617
TODO: Perhaps for this and similar methods, take a revision
618
parameter which can be either an integer revno or a
619
string hash."""
620
i = Inventory.read_xml(self.inventory_store[inventory_id])
621
return i
622
792
623
793
624
def get_revision_inventory(self, revision_id):
794
625
"""Return inventory of a past revision."""
795
# TODO: Unify this with get_inventory()
796
# bzr 0.0.6 and later imposes the constraint that the inventory_id
797
# must be the same as its revision, so this is trivial.
798
626
if revision_id == None:
799
return Inventory(self.get_root_id())
627
return Inventory()
800
628
else:
801
return self.get_inventory(revision_id)
802
803
@needs_read_lock
629
return self.get_inventory(self.get_revision(revision_id).inventory_id)
630
631
804
632
def revision_history(self):
805
"""Return sequence of revision hashes on to this branch."""
806
transaction = self.get_transaction()
807
history = transaction.map.find_revision_history()
808
if history is not None:
809
mutter("cache hit for revision-history in %s", self)
810
return list(history)
811
history = [l.rstrip('\r\n') for l in
812
self.controlfile('revision-history', 'r').readlines()]
813
transaction.map.add_revision_history(history)
814
# this call is disabled because revision_history is
815
# not really an object yet, and the transaction is for objects.
816
# transaction.register_clean(history, precious=True)
817
return list(history)
633
"""Return sequence of revision hashes on to this branch.
634
635
>>> ScratchBranch().revision_history()
636
[]
637
"""
638
return [chomp(l) for l in self.controlfile('revision-history', 'r').readlines()]
639
818
640
819
641
def revno(self):
820
642
"""Return current revision number for this branch.
821
643
822
644
That is equivalent to the number of revisions committed to
823
645
this branch.
646
647
>>> b = ScratchBranch()
648
>>> b.revno()
649
0
650
>>> b.commit('no foo')
651
>>> b.revno()
652
1
824
653
"""
825
654
return len(self.revision_history())
826
655
827
def last_revision(self):
656
657
def last_patch(self):
828
658
"""Return last patch hash, or None if no history.
659
660
>>> ScratchBranch().last_patch() == None
661
True
829
662
"""
830
663
ph = self.revision_history()
831
664
if ph:
832
665
return ph[-1]
833
666
else:
834
667
return None
835
836
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
837
"""Return a list of new revisions that would perfectly fit.
838
839
If self and other have not diverged, return a list of the revisions
840
present in other, but missing from self.
841
842
>>> from bzrlib.commit import commit
843
>>> bzrlib.trace.silent = True
844
>>> br1 = ScratchBranch()
845
>>> br2 = ScratchBranch()
846
>>> br1.missing_revisions(br2)
847
[]
848
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
849
>>> br1.missing_revisions(br2)
850
[u'REVISION-ID-1']
851
>>> br2.missing_revisions(br1)
852
[]
853
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
854
>>> br1.missing_revisions(br2)
855
[]
856
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
857
>>> br1.missing_revisions(br2)
858
[u'REVISION-ID-2A']
859
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
860
>>> br1.missing_revisions(br2)
861
Traceback (most recent call last):
862
DivergedBranches: These branches have diverged.
863
"""
864
self_history = self.revision_history()
865
self_len = len(self_history)
866
other_history = other.revision_history()
867
other_len = len(other_history)
868
common_index = min(self_len, other_len) -1
869
if common_index >= 0 and \
870
self_history[common_index] != other_history[common_index]:
871
raise DivergedBranches(self, other)
872
873
if stop_revision is None:
874
stop_revision = other_len
875
else:
876
assert isinstance(stop_revision, int)
877
if stop_revision > other_len:
878
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
879
return other_history[self_len:stop_revision]
880
881
def update_revisions(self, other, stop_revision=None):
882
"""Pull in new perfect-fit revisions."""
883
# FIXME: If the branches have diverged, but the latest
884
# revision in this branch is completely merged into the other,
885
# then we should still be able to pull.
886
from bzrlib.fetch import greedy_fetch
887
if stop_revision is None:
888
stop_revision = other.last_revision()
889
### Should this be checking is_ancestor instead of revision_history?
890
if (stop_revision is not None and
891
stop_revision in self.revision_history()):
892
return
893
greedy_fetch(to_branch=self, from_branch=other,
894
revision=stop_revision)
895
pullable_revs = self.pullable_revisions(other, stop_revision)
896
if len(pullable_revs) > 0:
897
self.append_revision(*pullable_revs)
898
899
def pullable_revisions(self, other, stop_revision):
900
other_revno = other.revision_id_to_revno(stop_revision)
901
try:
902
return self.missing_revisions(other, other_revno)
903
except DivergedBranches, e:
904
try:
905
pullable_revs = get_intervening_revisions(self.last_revision(),
906
stop_revision, self)
907
assert self.last_revision() not in pullable_revs
908
return pullable_revs
909
except bzrlib.errors.NotAncestor:
910
if is_ancestor(self.last_revision(), stop_revision, self):
911
return []
912
else:
913
raise e
914
915
def commit(self, *args, **kw):
916
from bzrlib.commit import Commit
917
Commit().commit(self, *args, **kw)
918
919
def revision_id_to_revno(self, revision_id):
920
"""Given a revision id, return its revno"""
921
if revision_id is None:
922
return 0
923
history = self.revision_history()
924
try:
925
return history.index(revision_id) + 1
926
except ValueError:
927
raise bzrlib.errors.NoSuchRevision(self, revision_id)
928
929
def get_rev_id(self, revno, history=None):
930
"""Find the revision id of the specified revno."""
668
669
670
def lookup_revision(self, revno):
671
"""Return revision hash for revision number."""
931
672
if revno == 0:
932
673
return None
933
if history is None:
934
history = self.revision_history()
935
elif revno <= 0 or revno > len(history):
936
raise bzrlib.errors.NoSuchRevision(self, revno)
937
return history[revno - 1]
674
675
try:
676
# list is 0-based; revisions are 1-based
677
return self.revision_history()[revno-1]
678
except IndexError:
679
raise BzrError("no such revision %s" % revno)
680
938
681
939
682
def revision_tree(self, revision_id):
940
683
"""Return Tree for a revision on this branch.
941
684
942
685
`revision_id` may be None for the null revision, in which case
943
686
an `EmptyTree` is returned."""
944
# TODO: refactor this to use an existing revision object
945
# so we don't need to read it in twice.
687
946
688
if revision_id == None:
947
689
return EmptyTree()
948
690
else:
949
691
inv = self.get_revision_inventory(revision_id)
950
return RevisionTree(self.weave_store, inv, revision_id)
692
return RevisionTree(self.text_store, inv)
693
951
694
952
695
def working_tree(self):
953
696
"""Return a `Tree` for the working copy."""
954
from bzrlib.workingtree import WorkingTree
955
# TODO: In the future, perhaps WorkingTree should utilize Transport
956
# RobertCollins 20051003 - I don't think it should - working trees are
957
# much more complex to keep consistent than our careful .bzr subset.
958
# instead, we should say that working trees are local only, and optimise
959
# for that.
960
return WorkingTree(self.base, branch=self)
697
return WorkingTree(self.base, self.read_working_inventory())
961
698
962
699
963
700
def basis_tree(self):
964
701
"""Return `Tree` object for last revision.
965
702
966
703
If there are no revisions yet, return an `EmptyTree`.
704
705
>>> b = ScratchBranch(files=['foo'])
706
>>> b.basis_tree().has_filename('foo')
707
False
708
>>> b.working_tree().has_filename('foo')
709
True
710
>>> b.add('foo')
711
>>> b.commit('add foo')
712
>>> b.basis_tree().has_filename('foo')
713
True
967
714
"""
968
return self.revision_tree(self.last_revision())
969
970
@needs_write_lock
715
r = self.last_patch()
716
if r == None:
717
return EmptyTree()
718
else:
719
return RevisionTree(self.text_store, self.get_revision_inventory(r))
720
721
722
723
def write_log(self, show_timezone='original', verbose=False):
724
"""Write out human-readable log of commits to this branch
725
726
utc -- If true, show dates in universal time, not local time."""
727
## TODO: Option to choose either original, utc or local timezone
728
revno = 1
729
precursor = None
730
for p in self.revision_history():
731
print '-' * 40
732
print 'revno:', revno
733
## TODO: Show hash if --id is given.
734
##print 'revision-hash:', p
735
rev = self.get_revision(p)
736
print 'committer:', rev.committer
737
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
738
show_timezone))
739
740
## opportunistic consistency check, same as check_patch_chaining
741
if rev.precursor != precursor:
742
bailout("mismatched precursor!")
743
744
print 'message:'
745
if not rev.message:
746
print ' (no message)'
747
else:
748
for l in rev.message.split('\n'):
749
print ' ' + l
750
751
if verbose == True and precursor != None:
752
print 'changed files:'
753
tree = self.revision_tree(p)
754
prevtree = self.revision_tree(precursor)
755
756
for file_state, fid, old_name, new_name, kind in \
757
diff_trees(prevtree, tree, ):
758
if file_state == 'A' or file_state == 'M':
759
show_status(file_state, kind, new_name)
760
elif file_state == 'D':
761
show_status(file_state, kind, old_name)
762
elif file_state == 'R':
763
show_status(file_state, kind,
764
old_name + ' => ' + new_name)
765
766
revno += 1
767
precursor = p
768
769
971
770
def rename_one(self, from_rel, to_rel):
972
"""Rename one file.
973
974
This can change the directory or the filename or both.
975
"""
976
771
tree = self.working_tree()
977
772
inv = tree.inventory
978
773
if not tree.has_filename(from_rel):
979
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
774
bailout("can't rename: old working file %r does not exist" % from_rel)
980
775
if tree.has_filename(to_rel):
981
raise BzrError("can't rename: new working file %r already exists" % to_rel)
982
776
bailout("can't rename: new working file %r already exists" % to_rel)
777
983
778
file_id = inv.path2id(from_rel)
984
779
if file_id == None:
985
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
780
bailout("can't rename: old name %r is not versioned" % from_rel)
986
781
987
782
if inv.path2id(to_rel):
988
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
783
bailout("can't rename: new name %r is already versioned" % to_rel)
989
784
990
785
to_dir, to_tail = os.path.split(to_rel)
991
786
to_dir_id = inv.path2id(to_dir)
992
787
if to_dir_id == None and to_dir != '':
993
raise BzrError("can't determine destination directory id for %r" % to_dir)
788
bailout("can't determine destination directory id for %r" % to_dir)
994
789
995
790
mutter("rename_one:")
996
791
mutter(" file_id {%s}" % file_id)
998
793
mutter(" to_rel %r" % to_rel)
999
794
mutter(" to_dir %r" % to_dir)
1000
795
mutter(" to_dir_id {%s}" % to_dir_id)
1001
796
1002
797
inv.rename(file_id, to_dir_id, to_tail)
1003
798
799
print "%s => %s" % (from_rel, to_rel)
800
1004
801
from_abs = self.abspath(from_rel)
1005
802
to_abs = self.abspath(to_rel)
1006
803
try:
1007
rename(from_abs, to_abs)
804
os.rename(from_abs, to_abs)
1008
805
except OSError, e:
1009
raise BzrError("failed to rename %r to %r: %s"
806
bailout("failed to rename %r to %r: %s"
1010
807
% (from_abs, to_abs, e[1]),
1011
808
["rename rolled back"])
1012
809
1013
810
self._write_inventory(inv)
1014
1015
@needs_write_lock
811
812
813
1016
814
def move(self, from_paths, to_name):
1017
815
"""Rename files.
1018
816
1023
821
1024
822
Note that to_name is only the last component of the new name;
1025
823
this doesn't change the directory.
1026
1027
This returns a list of (from_path, to_path) pairs for each
1028
entry that is moved.
1029
824
"""
1030
result = []
1031
825
## TODO: Option to move IDs only
1032
826
assert not isinstance(from_paths, basestring)
1033
827
tree = self.working_tree()
1034
828
inv = tree.inventory
1035
829
to_abs = self.abspath(to_name)
1036
830
if not isdir(to_abs):
1037
raise BzrError("destination %r is not a directory" % to_abs)
831
bailout("destination %r is not a directory" % to_abs)
1038
832
if not tree.has_filename(to_name):
1039
raise BzrError("destination %r not in working directory" % to_abs)
833
bailout("destination %r not in working directory" % to_abs)
1040
834
to_dir_id = inv.path2id(to_name)
1041
835
if to_dir_id == None and to_name != '':
1042
raise BzrError("destination %r is not a versioned directory" % to_name)
836
bailout("destination %r is not a versioned directory" % to_name)
1043
837
to_dir_ie = inv[to_dir_id]
1044
838
if to_dir_ie.kind not in ('directory', 'root_directory'):
1045
raise BzrError("destination %r is not a directory" % to_abs)
839
bailout("destination %r is not a directory" % to_abs)
1046
840
1047
to_idpath = inv.get_idpath(to_dir_id)
841
to_idpath = Set(inv.get_idpath(to_dir_id))
1048
842
1049
843
for f in from_paths:
1050
844
if not tree.has_filename(f):
1051
raise BzrError("%r does not exist in working tree" % f)
845
bailout("%r does not exist in working tree" % f)
1052
846
f_id = inv.path2id(f)
1053
847
if f_id == None:
1054
raise BzrError("%r is not versioned" % f)
848
bailout("%r is not versioned" % f)
1055
849
name_tail = splitpath(f)[-1]
1056
850
dest_path = appendpath(to_name, name_tail)
1057
851
if tree.has_filename(dest_path):
1058
raise BzrError("destination %r already exists" % dest_path)
852
bailout("destination %r already exists" % dest_path)
1059
853
if f_id in to_idpath:
1060
raise BzrError("can't move %r to a subdirectory of itself" % f)
854
bailout("can't move %r to a subdirectory of itself" % f)
1061
855
1062
856
# OK, so there's a race here, it's possible that someone will
1063
857
# create a file in this interval and then the rename might be
1066
860
for f in from_paths:
1067
861
name_tail = splitpath(f)[-1]
1068
862
dest_path = appendpath(to_name, name_tail)
1069
result.append((f, dest_path))
863
print "%s => %s" % (f, dest_path)
1070
864
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1071
865
try:
1072
rename(self.abspath(f), self.abspath(dest_path))
866
os.rename(self.abspath(f), self.abspath(dest_path))
1073
867
except OSError, e:
1074
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
868
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1075
869
["rename rolled back"])
1076
870
1077
871
self._write_inventory(inv)
1078
return result
1079
1080
1081
def revert(self, filenames, old_tree=None, backups=True):
1082
"""Restore selected files to the versions from a previous tree.
1083
1084
backups
1085
If true (default) backups are made of files before
1086
they're renamed.
1087
"""
1088
from bzrlib.atomicfile import AtomicFile
1089
from bzrlib.osutils import backup_file
1090
1091
inv = self.read_working_inventory()
1092
if old_tree is None:
1093
old_tree = self.basis_tree()
1094
old_inv = old_tree.inventory
1095
1096
nids = []
1097
for fn in filenames:
1098
file_id = inv.path2id(fn)
1099
if not file_id:
1100
raise NotVersionedError(path=fn)
1101
if not old_inv.has_id(file_id):
1102
raise BzrError("file not present in old tree", fn, file_id)
1103
nids.append((fn, file_id))
1104
1105
# TODO: Rename back if it was previously at a different location
1106
1107
# TODO: If given a directory, restore the entire contents from
1108
# the previous version.
1109
1110
# TODO: Make a backup to a temporary file.
1111
1112
# TODO: If the file previously didn't exist, delete it?
1113
for fn, file_id in nids:
1114
backup_file(fn)
1115
1116
f = AtomicFile(fn, 'wb')
1117
try:
1118
f.write(old_tree.get_file(file_id).read())
1119
f.commit()
1120
finally:
1121
f.close()
1122
1123
1124
def pending_merges(self):
1125
"""Return a list of pending merges.
1126
1127
These are revisions that have been merged into the working
1128
directory but not yet committed.
1129
"""
1130
cfn = self._rel_controlfilename('pending-merges')
1131
if not self._transport.has(cfn):
1132
return []
1133
p = []
1134
for l in self.controlfile('pending-merges', 'r').readlines():
1135
p.append(l.rstrip('\n'))
1136
return p
1137
1138
1139
def add_pending_merge(self, *revision_ids):
1140
# TODO: Perhaps should check at this point that the
1141
# history of the revision is actually present?
1142
p = self.pending_merges()
1143
updated = False
1144
for rev_id in revision_ids:
1145
if rev_id in p:
1146
continue
1147
p.append(rev_id)
1148
updated = True
1149
if updated:
1150
self.set_pending_merges(p)
1151
1152
@needs_write_lock
1153
def set_pending_merges(self, rev_list):
1154
self.put_controlfile('pending-merges', '\n'.join(rev_list))
1155
1156
def get_parent(self):
1157
"""Return the parent location of the branch.
1158
1159
This is the default location for push/pull/missing. The usual
1160
pattern is that the user can override it by specifying a
1161
location.
1162
"""
1163
import errno
1164
_locs = ['parent', 'pull', 'x-pull']
1165
for l in _locs:
1166
try:
1167
return self.controlfile(l, 'r').read().strip('\n')
1168
except IOError, e:
1169
if e.errno != errno.ENOENT:
1170
raise
1171
return None
1172
1173
@needs_write_lock
1174
def set_parent(self, url):
1175
# TODO: Maybe delete old location files?
1176
from bzrlib.atomicfile import AtomicFile
1177
f = AtomicFile(self.controlfilename('parent'))
1178
try:
1179
f.write(url + '\n')
1180
f.commit()
1181
finally:
1182
f.close()
1183
1184
def check_revno(self, revno):
1185
"""\
1186
Check whether a revno corresponds to any revision.
1187
Zero (the NULL revision) is considered valid.
1188
"""
1189
if revno != 0:
1190
self.check_real_revno(revno)
1191
1192
def check_real_revno(self, revno):
1193
"""\
1194
Check whether a revno corresponds to a real revision.
1195
Zero (the NULL revision) is considered invalid
1196
"""
1197
if revno < 1 or revno > self.revno():
1198
raise InvalidRevisionNumber(revno)
1199
1200
def sign_revision(self, revision_id, gpg_strategy):
1201
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1202
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1203
1204
@needs_write_lock
1205
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1206
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1207
revision_id, "sig")
1208
1209
1210
class ScratchBranch(_Branch):
872
873
874
875
def show_status(self, show_all=False):
876
"""Display single-line status for non-ignored working files.
877
878
The list is show sorted in order by file name.
879
880
>>> b = ScratchBranch(files=['foo', 'foo~'])
881
>>> b.show_status()
882
? foo
883
>>> b.add('foo')
884
>>> b.show_status()
885
A foo
886
>>> b.commit("add foo")
887
>>> b.show_status()
888
>>> os.unlink(b.abspath('foo'))
889
>>> b.show_status()
890
D foo
891
892
TODO: Get state for single files.
893
"""
894
895
# We have to build everything into a list first so that it can
896
# sorted by name, incorporating all the different sources.
897
898
# FIXME: Rather than getting things in random order and then sorting,
899
# just step through in order.
900
901
# Interesting case: the old ID for a file has been removed,
902
# but a new file has been created under that name.
903
904
old = self.basis_tree()
905
new = self.working_tree()
906
907
for fs, fid, oldname, newname, kind in diff_trees(old, new):
908
if fs == 'R':
909
show_status(fs, kind,
910
oldname + ' => ' + newname)
911
elif fs == 'A' or fs == 'M':
912
show_status(fs, kind, newname)
913
elif fs == 'D':
914
show_status(fs, kind, oldname)
915
elif fs == '.':
916
if show_all:
917
show_status(fs, kind, newname)
918
elif fs == 'I':
919
if show_all:
920
show_status(fs, kind, newname)
921
elif fs == '?':
922
show_status(fs, kind, newname)
923
else:
924
bailout("weird file state %r" % ((fs, fid),))
925
926
927
928
class ScratchBranch(Branch):
1211
929
"""Special test class: a branch that cleans up after itself.
1212
930
1213
931
>>> b = ScratchBranch()
1214
932
>>> isdir(b.base)
1215
933
True
1216
934
>>> bd = b.base
1217
>>> b._transport.__del__()
935
>>> del b
1218
936
>>> isdir(bd)
1219
937
False
1220
938
"""
1221
1222
def __init__(self, files=[], dirs=[], transport=None):
939
def __init__(self, files=[], dirs=[]):
1223
940
"""Make a test branch.
1224
941
1225
942
This creates a temporary directory and runs init-tree in it.
1226
943
1227
944
If any files are listed, they are created in the working copy.
1228
945
"""
1229
if transport is None:
1230
transport = bzrlib.transport.local.ScratchTransport()
1231
super(ScratchBranch, self).__init__(transport, init=True)
1232
else:
1233
super(ScratchBranch, self).__init__(transport)
1234
946
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1235
947
for d in dirs:
1236
self._transport.mkdir(d)
948
os.mkdir(self.abspath(d))
1237
949
1238
950
for f in files:
1239
self._transport.put(f, 'content of %s' % f)
1240
1241
1242
def clone(self):
1243
"""
1244
>>> orig = ScratchBranch(files=["file1", "file2"])
1245
>>> clone = orig.clone()
1246
>>> if os.name != 'nt':
1247
... os.path.samefile(orig.base, clone.base)
1248
... else:
1249
... orig.base == clone.base
1250
...
1251
False
1252
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1253
True
1254
"""
1255
from shutil import copytree
1256
from tempfile import mkdtemp
1257
base = mkdtemp()
1258
os.rmdir(base)
1259
copytree(self.base, base, symlinks=True)
1260
return ScratchBranch(
1261
transport=bzrlib.transport.local.ScratchTransport(base))
951
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
952
953
954
def __del__(self):
955
"""Destroy the test branch, removing the scratch directory."""
956
try:
957
shutil.rmtree(self.base)
958
except OSError:
959
# Work around for shutil.rmtree failing on Windows when
960
# readonly files are encountered
961
for root, dirs, files in os.walk(self.base, topdown=False):
962
for name in files:
963
os.chmod(os.path.join(root, name), 0700)
964
shutil.rmtree(self.base)
965
1262
966
1263
967
1264
968
######################################################################
1280
984
1281
985
1282
986
987
def _gen_revision_id(when):
988
"""Return new revision-id."""
989
s = '%s-%s-' % (user_email(), compact_date(when))
990
s += hexlify(rand_bytes(8))
991
return s
992
993
1283
994
def gen_file_id(name):
1284
995
"""Return new file id.
1285
996
1286
997
This should probably generate proper UUIDs, but for the moment we
1287
998
cope with just randomness because running uuidgen every time is
1288
999
slow."""
1289
import re
1290
from binascii import hexlify
1291
from time import time
1292
1293
# get last component
1294
1000
idx = name.rfind('/')
1295
1001
if idx != -1:
1296
1002
name = name[idx+1 : ]
1298
1004
if idx != -1:
1299
1005
name = name[idx+1 : ]
1300
1006
1301
# make it not a hidden file
1302
1007
name = name.lstrip('.')
1303
1008
1304
# remove any wierd characters; we don't escape them but rather
1305
# just pull them out
1306
name = re.sub(r'[^\w.]', '', name)
1307
1308
1009
s = hexlify(rand_bytes(8))
1309
return '-'.join((name, compact_date(time()), s))
1310
1311
1312
def gen_root_id():
1313
"""Return a new tree-root file id."""
1314
return gen_file_id('TREE_ROOT')
1315
1316
1010
return '-'.join((name, compact_date(time.time()), s))
Loggerhead is a web-based interface for Breezy
Version: 2.0.1