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