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