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