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