« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 542
- compare with another revision
- download diff
- download tarball
- view history from revision 542
- Committer: Martin Pool
- Date: 2005-05-19 08:31:06 UTC
- Revision ID: mbp@sourcefrog.net-20050519083106-ebe71562d3bda4a7
- fix typo
- files added:
- .bzrignore
- contrib
- contrib/bash
- contrib/zsh
- elementtree
- patches
- urlgrabber
- files removed:
- bzrlib/tests.py
- files renamed:
- bzr.py => bzrlib/commands.py
- files modified:
- README
added
removed
bzrlib/branch.py
1
#! /usr/bin/env python
2
# -*- coding: UTF-8 -*-
1
# Copyright (C) 2005 Canonical Ltd
3
2
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
16
18
17
19
from sets import Set
20
21
18
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
22
19
import traceback, socket, fnmatch, difflib, time
23
20
from binascii import hexlify
25
22
import bzrlib
26
23
from inventory import Inventory
27
24
from trace import mutter, note
28
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
25
from tree import Tree, EmptyTree, RevisionTree
29
26
from inventory import InventoryEntry, Inventory
30
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
27
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
31
28
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
32
joinpath, sha_string, file_kind, local_time_offset
29
joinpath, sha_string, file_kind, local_time_offset, appendpath
33
30
from store import ImmutableStore
34
31
from revision import Revision
35
from errors import bailout
32
from errors import bailout, BzrError
36
33
from textui import show_status
37
from diff import diff_trees
38
34
39
35
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
40
36
## TODO: Maybe include checks for common corruption of newlines, etc?
41
37
42
38
43
39
40
def find_branch(f, **args):
41
if f and (f.startswith('http://') or f.startswith('https://')):
42
import remotebranch
43
return remotebranch.RemoteBranch(f, **args)
44
else:
45
return Branch(f, **args)
46
47
48
def find_branch_root(f=None):
49
"""Find the branch root enclosing f, or pwd.
50
51
f may be a filename or a URL.
52
53
It is not necessary that f exists.
54
55
Basically we keep looking up until we find the control directory or
56
run into the root."""
57
if f == None:
58
f = os.getcwd()
59
elif hasattr(os.path, 'realpath'):
60
f = os.path.realpath(f)
61
else:
62
f = os.path.abspath(f)
63
if not os.path.exists(f):
64
raise BzrError('%r does not exist' % f)
65
66
67
orig_f = f
68
69
while True:
70
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
71
return f
72
head, tail = os.path.split(f)
73
if head == f:
74
# reached the root, whatever that may be
75
raise BzrError('%r is not in a branch' % orig_f)
76
f = head
77
44
78
45
79
46
80
######################################################################
49
83
class Branch:
50
84
"""Branch holding a history of revisions.
51
85
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.
86
base
87
Base directory of the branch.
64
88
"""
65
def __init__(self, base, init=False):
89
_lockmode = None
90
91
def __init__(self, base, init=False, find_root=True, lock_mode='w'):
66
92
"""Create new branch object at a particular location.
67
93
68
:param base: Base directory for the branch.
69
70
:param init: If True, create new control files in a previously
94
base -- Base directory for the branch.
95
96
init -- If True, create new control files in a previously
71
97
unversioned directory. If False, the branch must already
72
98
be versioned.
73
99
100
find_root -- If true and init is false, find the root of the
101
existing branch containing base.
102
74
103
In the test suite, creation of new trees is tested using the
75
104
`ScratchBranch` class.
76
105
"""
77
self.base = os.path.realpath(base)
78
106
if init:
107
self.base = os.path.realpath(base)
79
108
self._make_control()
109
elif find_root:
110
self.base = find_branch_root(base)
80
111
else:
112
self.base = os.path.realpath(base)
81
113
if not isdir(self.controlfilename('.')):
82
114
bailout("not a bzr branch: %s" % quotefn(base),
83
115
['use "bzr init" to initialize a new working tree',
84
116
'current bzr can only operate from top-of-tree'])
85
self._check_format()
117
self._check_format()
118
self.lock(lock_mode)
86
119
87
120
self.text_store = ImmutableStore(self.controlfilename('text-store'))
88
121
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
96
129
__repr__ = __str__
97
130
98
131
99
def _rel(self, name):
100
"""Return filename relative to branch top"""
132
133
def lock(self, mode='w'):
134
"""Lock the on-disk branch, excluding other processes."""
135
try:
136
import fcntl, errno
137
138
if mode == 'w':
139
lm = fcntl.LOCK_EX
140
om = os.O_WRONLY | os.O_CREAT
141
elif mode == 'r':
142
lm = fcntl.LOCK_SH
143
om = os.O_RDONLY
144
else:
145
raise BzrError("invalid locking mode %r" % mode)
146
147
try:
148
lockfile = os.open(self.controlfilename('branch-lock'), om)
149
except OSError, e:
150
if e.errno == errno.ENOENT:
151
# might not exist on branches from <0.0.4
152
self.controlfile('branch-lock', 'w').close()
153
lockfile = os.open(self.controlfilename('branch-lock'), om)
154
else:
155
raise e
156
157
fcntl.lockf(lockfile, lm)
158
def unlock():
159
fcntl.lockf(lockfile, fcntl.LOCK_UN)
160
os.close(lockfile)
161
self._lockmode = None
162
self.unlock = unlock
163
self._lockmode = mode
164
except ImportError:
165
warning("please write a locking method for platform %r" % sys.platform)
166
def unlock():
167
self._lockmode = None
168
self.unlock = unlock
169
self._lockmode = mode
170
171
172
def _need_readlock(self):
173
if self._lockmode not in ['r', 'w']:
174
raise BzrError('need read lock on branch, only have %r' % self._lockmode)
175
176
def _need_writelock(self):
177
if self._lockmode not in ['w']:
178
raise BzrError('need write lock on branch, only have %r' % self._lockmode)
179
180
181
def abspath(self, name):
182
"""Return absolute filename for something in the branch"""
101
183
return os.path.join(self.base, name)
102
184
185
186
def relpath(self, path):
187
"""Return path relative to this branch of something inside it.
188
189
Raises an error if path is not in this branch."""
190
rp = os.path.realpath(path)
191
# FIXME: windows
192
if not rp.startswith(self.base):
193
bailout("path %r is not within branch %r" % (rp, self.base))
194
rp = rp[len(self.base):]
195
rp = rp.lstrip(os.sep)
196
return rp
197
103
198
104
199
def controlfilename(self, file_or_path):
105
200
"""Return location relative to branch."""
109
204
110
205
111
206
def controlfile(self, file_or_path, mode='r'):
112
"""Open a control file for this branch"""
113
return file(self.controlfilename(file_or_path), mode)
207
"""Open a control file for this branch.
208
209
There are two classes of file in the control directory: text
210
and binary. binary files are untranslated byte streams. Text
211
control files are stored with Unix newlines and in UTF-8, even
212
if the platform or locale defaults are different.
213
214
Controlfiles should almost never be opened in write mode but
215
rather should be atomically copied and replaced using atomicfile.
216
"""
217
218
fn = self.controlfilename(file_or_path)
219
220
if mode == 'rb' or mode == 'wb':
221
return file(fn, mode)
222
elif mode == 'r' or mode == 'w':
223
# open in binary mode anyhow so there's no newline translation;
224
# codecs uses line buffering by default; don't want that.
225
import codecs
226
return codecs.open(fn, mode + 'b', 'utf-8',
227
buffering=60000)
228
else:
229
raise BzrError("invalid controlfile mode %r" % mode)
230
114
231
115
232
116
233
def _make_control(self):
122
239
for d in ('text-store', 'inventory-store', 'revision-store'):
123
240
os.mkdir(self.controlfilename(d))
124
241
for f in ('revision-history', 'merged-patches',
125
'pending-merged-patches', 'branch-name'):
242
'pending-merged-patches', 'branch-name',
243
'branch-lock'):
126
244
self.controlfile(f, 'w').write('')
127
245
mutter('created control directory in ' + self.base)
128
246
Inventory().write_xml(self.controlfile('inventory','w'))
135
253
136
254
In the future, we might need different in-memory Branch
137
255
classes to support downlevel branches. But not yet.
138
"""
139
# read in binary mode to detect newline wierdness.
140
fmt = self.controlfile('branch-format', 'rb').read()
256
"""
257
# This ignores newlines so that we can open branches created
258
# on Windows from Linux and so on. I think it might be better
259
# to always make all internal files in unix format.
260
fmt = self.controlfile('branch-format', 'r').read()
261
fmt.replace('\r\n', '')
141
262
if fmt != BZR_BRANCH_FORMAT:
142
263
bailout('sorry, branch format %r not supported' % fmt,
143
264
['use a different bzr version',
146
267
147
268
def read_working_inventory(self):
148
269
"""Read the working inventory."""
270
self._need_readlock()
149
271
before = time.time()
150
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
272
# ElementTree does its own conversion from UTF-8, so open in
273
# binary.
274
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
151
275
mutter("loaded inventory of %d items in %f"
152
276
% (len(inv), time.time() - before))
153
277
return inv
159
283
That is to say, the inventory describing changes underway, that
160
284
will be committed to the next revision.
161
285
"""
286
self._need_writelock()
162
287
## TODO: factor out to atomicfile? is rename safe on windows?
288
## TODO: Maybe some kind of clean/dirty marker on inventory?
163
289
tmpfname = self.controlfilename('inventory.tmp')
164
tmpf = file(tmpfname, 'w')
290
tmpf = file(tmpfname, 'wb')
165
291
inv.write_xml(tmpf)
166
292
tmpf.close()
167
os.rename(tmpfname, self.controlfilename('inventory'))
293
inv_fname = self.controlfilename('inventory')
294
if sys.platform == 'win32':
295
os.remove(inv_fname)
296
os.rename(tmpfname, inv_fname)
168
297
mutter('wrote working inventory')
169
298
170
299
172
301
"""Inventory for the working copy.""")
173
302
174
303
175
def add(self, files, verbose=False):
304
def add(self, files, verbose=False, ids=None):
176
305
"""Make files versioned.
177
306
307
Note that the command line normally calls smart_add instead.
308
178
309
This puts the files in the Added state, so that they will be
179
310
recorded by the next commit.
180
311
181
:todo: Perhaps have an option to add the ids even if the files do
312
TODO: Perhaps have an option to add the ids even if the files do
182
313
not (yet) exist.
183
314
184
:todo: Perhaps return the ids of the files? But then again it
315
TODO: Perhaps return the ids of the files? But then again it
185
316
is easy to retrieve them if they're needed.
186
317
187
:todo: Option to specify file id.
318
TODO: Option to specify file id.
188
319
189
:todo: Adding a directory should optionally recurse down and
320
TODO: Adding a directory should optionally recurse down and
190
321
add all non-ignored children. Perhaps do that in a
191
322
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', [])
214
323
"""
324
self._need_writelock()
215
325
216
326
# TODO: Re-adding a file that is removed in the working copy
217
327
# should probably put it back with the previous ID.
218
328
if isinstance(files, types.StringTypes):
329
assert(ids is None or isinstance(ids, types.StringTypes))
219
330
files = [files]
331
if ids is not None:
332
ids = [ids]
333
334
if ids is None:
335
ids = [None] * len(files)
336
else:
337
assert(len(ids) == len(files))
220
338
221
339
inv = self.read_working_inventory()
222
for f in files:
340
for f,file_id in zip(files, ids):
223
341
if is_control_file(f):
224
342
bailout("cannot add control file %s" % quotefn(f))
225
343
228
346
if len(fp) == 0:
229
347
bailout("cannot add top-level %r" % f)
230
348
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))
349
fullpath = os.path.normpath(self.abspath(f))
350
351
try:
352
kind = file_kind(fullpath)
353
except OSError:
354
# maybe something better?
355
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
356
357
if kind != 'file' and kind != 'directory':
358
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
359
360
if file_id is None:
361
file_id = gen_file_id(f)
362
inv.add_path(f, kind=kind, file_id=file_id)
363
252
364
if verbose:
253
365
show_status('A', kind, quotefn(f))
254
366
255
mutter("add file %s file_id:{%s} kind=%r parent_id={%s}"
256
% (f, file_id, kind, parent_id))
367
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
368
257
369
self._write_inventory(inv)
258
370
259
371
372
def print_file(self, file, revno):
373
"""Print `file` to stdout."""
374
self._need_readlock()
375
tree = self.revision_tree(self.lookup_revision(revno))
376
# use inventory as it was in that revision
377
file_id = tree.inventory.path2id(file)
378
if not file_id:
379
bailout("%r is not present in revision %d" % (file, revno))
380
tree.print_file(file_id)
381
260
382
261
383
def remove(self, files, verbose=False):
262
384
"""Mark nominated files for removal from the inventory.
263
385
264
386
This does not remove their text. This does not run on
265
387
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
388
TODO: Refuse to remove modified files unless --force is given?
389
390
TODO: Do something useful with directories.
391
392
TODO: Should this remove the text or not? Tough call; not
293
393
removing may be useful and the user can just use use rm, and
294
394
is the opposite of add. Removing it is consistent with most
295
395
other tools. Maybe an option.
296
396
"""
297
397
## TODO: Normalize names
298
398
## TODO: Remove nested loops; better scalability
399
self._need_writelock()
299
400
300
401
if isinstance(files, types.StringTypes):
301
402
files = [files]
302
403
303
inv = self.read_working_inventory()
404
tree = self.working_tree()
405
inv = tree.inventory
304
406
305
407
# do this before any modifications
306
408
for f in files:
309
411
bailout("cannot remove unversioned file %s" % quotefn(f))
310
412
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
311
413
if verbose:
312
show_status('D', inv[fid].kind, quotefn(f))
414
# having remove it, it must be either ignored or unknown
415
if tree.is_ignored(f):
416
new_status = 'I'
417
else:
418
new_status = '?'
419
show_status(new_status, inv[fid].kind, quotefn(f))
313
420
del inv[fid]
314
421
315
422
self._write_inventory(inv)
316
423
424
def set_inventory(self, new_inventory_list):
425
inv = Inventory()
426
for path, file_id, parent, kind in new_inventory_list:
427
name = os.path.basename(path)
428
if name == "":
429
continue
430
inv.add(InventoryEntry(file_id, name, kind, parent))
431
self._write_inventory(inv)
432
317
433
318
434
def unknowns(self):
319
435
"""Return all unknown files.
334
450
return self.working_tree().unknowns()
335
451
336
452
337
def commit(self, message, timestamp=None, timezone=None,
338
committer=None,
339
verbose=False):
340
"""Commit working copy as a new revision.
341
342
The basic approach is to add all the file texts into the
343
store, then the inventory, then make a new revision pointing
344
to that inventory and store that.
345
346
This is not quite safe if the working copy changes during the
347
commit; for the moment that is simply not allowed. A better
348
approach is to make a temporary copy of the files before
349
computing their hashes, and then add those hashes in turn to
350
the inventory. This should mean at least that there are no
351
broken hash pointers. There is no way we can get a snapshot
352
of the whole directory at an instant. This would also have to
353
be robust against files disappearing, moving, etc. So the
354
whole thing is a bit hard.
355
356
:param timestamp: if not None, seconds-since-epoch for a
357
postdated/predated commit.
358
"""
359
360
## TODO: Show branch names
361
362
# TODO: Don't commit if there are no changes, unless forced?
363
364
# First walk over the working inventory; and both update that
365
# and also build a new revision inventory. The revision
366
# inventory needs to hold the text-id, sha1 and size of the
367
# actual file versions committed in the revision. (These are
368
# not present in the working inventory.) We also need to
369
# detect missing/deleted files, and remove them from the
370
# working inventory.
371
372
work_inv = self.read_working_inventory()
373
inv = Inventory()
374
basis = self.basis_tree()
375
basis_inv = basis.inventory
376
missing_ids = []
377
for path, entry in work_inv.iter_entries():
378
## TODO: Cope with files that have gone missing.
379
380
## TODO: Check that the file kind has not changed from the previous
381
## revision of this file (if any).
382
383
entry = entry.copy()
384
385
p = self._rel(path)
386
file_id = entry.file_id
387
mutter('commit prep file %s, id %r ' % (p, file_id))
388
389
if not os.path.exists(p):
390
mutter(" file is missing, removing from inventory")
391
if verbose:
392
show_status('D', entry.kind, quotefn(path))
393
missing_ids.append(file_id)
394
continue
395
396
# TODO: Handle files that have been deleted
397
398
# TODO: Maybe a special case for empty files? Seems a
399
# waste to store them many times.
400
401
inv.add(entry)
402
403
if basis_inv.has_id(file_id):
404
old_kind = basis_inv[file_id].kind
405
if old_kind != entry.kind:
406
bailout("entry %r changed kind from %r to %r"
407
% (file_id, old_kind, entry.kind))
408
409
if entry.kind == 'directory':
410
if not isdir(p):
411
bailout("%s is entered as directory but not a directory" % quotefn(p))
412
elif entry.kind == 'file':
413
if not isfile(p):
414
bailout("%s is entered as file but is not a file" % quotefn(p))
415
416
content = file(p, 'rb').read()
417
418
entry.text_sha1 = sha_string(content)
419
entry.text_size = len(content)
420
421
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
422
if (old_ie
423
and (old_ie.text_size == entry.text_size)
424
and (old_ie.text_sha1 == entry.text_sha1)):
425
## assert content == basis.get_file(file_id).read()
426
entry.text_id = basis_inv[file_id].text_id
427
mutter(' unchanged from previous text_id {%s}' %
428
entry.text_id)
429
430
else:
431
entry.text_id = _gen_file_id(entry.name)
432
self.text_store.add(content, entry.text_id)
433
mutter(' stored with text_id {%s}' % entry.text_id)
434
if verbose:
435
if not old_ie:
436
state = 'A'
437
elif (old_ie.name == entry.name
438
and old_ie.parent_id == entry.parent_id):
439
state = 'R'
440
else:
441
state = 'M'
442
443
show_status(state, entry.kind, quotefn(path))
444
445
for file_id in missing_ids:
446
# have to do this later so we don't mess up the iterator.
447
# since parents may be removed before their children we
448
# have to test.
449
450
# FIXME: There's probably a better way to do this; perhaps
451
# the workingtree should know how to filter itself.
452
if work_inv.has_id(file_id):
453
del work_inv[file_id]
454
455
456
inv_id = rev_id = _gen_revision_id(time.time())
457
458
inv_tmp = tempfile.TemporaryFile()
459
inv.write_xml(inv_tmp)
460
inv_tmp.seek(0)
461
self.inventory_store.add(inv_tmp, inv_id)
462
mutter('new inventory_id is {%s}' % inv_id)
463
464
self._write_inventory(work_inv)
465
466
if timestamp == None:
467
timestamp = time.time()
468
469
if committer == None:
470
committer = username()
471
472
if timezone == None:
473
timezone = local_time_offset()
474
475
mutter("building commit log message")
476
rev = Revision(timestamp=timestamp,
477
timezone=timezone,
478
committer=committer,
479
precursor = self.last_patch(),
480
message = message,
481
inventory_id=inv_id,
482
revision_id=rev_id)
483
484
rev_tmp = tempfile.TemporaryFile()
485
rev.write_xml(rev_tmp)
486
rev_tmp.seek(0)
487
self.revision_store.add(rev_tmp, rev_id)
488
mutter("new revision_id is {%s}" % rev_id)
489
490
## XXX: Everything up to here can simply be orphaned if we abort
491
## the commit; it will leave junk files behind but that doesn't
492
## matter.
493
494
## TODO: Read back the just-generated changeset, and make sure it
495
## applies and recreates the right state.
496
497
## TODO: Also calculate and store the inventory SHA1
498
mutter("committing patch r%d" % (self.revno() + 1))
499
500
mutter("append to revision-history")
501
self.controlfile('revision-history', 'at').write(rev_id + '\n')
502
503
mutter("done!")
453
def append_revision(self, revision_id):
454
mutter("add {%s} to revision-history" % revision_id)
455
rev_history = self.revision_history()
456
457
tmprhname = self.controlfilename('revision-history.tmp')
458
rhname = self.controlfilename('revision-history')
459
460
f = file(tmprhname, 'wt')
461
rev_history.append(revision_id)
462
f.write('\n'.join(rev_history))
463
f.write('\n')
464
f.close()
465
466
if sys.platform == 'win32':
467
os.remove(rhname)
468
os.rename(tmprhname, rhname)
469
504
470
505
471
506
472
def get_revision(self, revision_id):
507
473
"""Return the Revision object for a named revision"""
474
self._need_readlock()
508
475
r = Revision.read_xml(self.revision_store[revision_id])
509
476
assert r.revision_id == revision_id
510
477
return r
513
480
def get_inventory(self, inventory_id):
514
481
"""Get Inventory object by hash.
515
482
516
:todo: Perhaps for this and similar methods, take a revision
483
TODO: Perhaps for this and similar methods, take a revision
517
484
parameter which can be either an integer revno or a
518
485
string hash."""
486
self._need_readlock()
519
487
i = Inventory.read_xml(self.inventory_store[inventory_id])
520
488
return i
521
489
522
490
523
491
def get_revision_inventory(self, revision_id):
524
492
"""Return inventory of a past revision."""
493
self._need_readlock()
525
494
if revision_id == None:
526
495
return Inventory()
527
496
else:
534
503
>>> ScratchBranch().revision_history()
535
504
[]
536
505
"""
537
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
506
self._need_readlock()
507
return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
508
509
510
def enum_history(self, direction):
511
"""Return (revno, revision_id) for history of branch.
512
513
direction
514
'forward' is from earliest to latest
515
'reverse' is from latest to earliest
516
"""
517
rh = self.revision_history()
518
if direction == 'forward':
519
i = 1
520
for rid in rh:
521
yield i, rid
522
i += 1
523
elif direction == 'reverse':
524
i = len(rh)
525
while i > 0:
526
yield i, rh[i-1]
527
i -= 1
528
else:
529
raise ValueError('invalid history direction', direction)
538
530
539
531
540
532
def revno(self):
542
534
543
535
That is equivalent to the number of revisions committed to
544
536
this branch.
545
546
>>> b = ScratchBranch()
547
>>> b.revno()
548
0
549
>>> b.commit('no foo')
550
>>> b.revno()
551
1
552
537
"""
553
538
return len(self.revision_history())
554
539
555
540
556
541
def last_patch(self):
557
542
"""Return last patch hash, or None if no history.
558
559
>>> ScratchBranch().last_patch() == None
560
True
561
543
"""
562
544
ph = self.revision_history()
563
545
if ph:
564
546
return ph[-1]
565
547
else:
548
return None
549
550
551
def commit(self, *args, **kw):
552
"""Deprecated"""
553
from bzrlib.commit import commit
554
commit(self, *args, **kw)
555
566
556
567
557
def lookup_revision(self, revno):
568
558
"""Return revision hash for revision number."""
573
563
# list is 0-based; revisions are 1-based
574
564
return self.revision_history()[revno-1]
575
565
except IndexError:
576
bailout("no such revision %s" % revno)
566
raise BzrError("no such revision %s" % revno)
577
567
578
568
579
569
def revision_tree(self, revision_id):
581
571
582
572
`revision_id` may be None for the null revision, in which case
583
573
an `EmptyTree` is returned."""
584
574
# TODO: refactor this to use an existing revision object
575
# so we don't need to read it in twice.
576
self._need_readlock()
585
577
if revision_id == None:
586
578
return EmptyTree()
587
579
else:
591
583
592
584
def working_tree(self):
593
585
"""Return a `Tree` for the working copy."""
586
from workingtree import WorkingTree
594
587
return WorkingTree(self.base, self.read_working_inventory())
595
588
596
589
598
591
"""Return `Tree` object for last revision.
599
592
600
593
If there are no revisions yet, return an `EmptyTree`.
601
602
>>> b = ScratchBranch(files=['foo'])
603
>>> b.basis_tree().has_filename('foo')
604
False
605
>>> b.working_tree().has_filename('foo')
606
True
607
>>> b.add('foo')
608
>>> b.commit('add foo')
609
>>> b.basis_tree().has_filename('foo')
610
True
611
594
"""
612
595
r = self.last_patch()
613
596
if r == None:
617
600
618
601
619
602
620
def write_log(self, show_timezone='original'):
621
"""Write out human-readable log of commits to this branch
622
623
:param utc: If true, show dates in universal time, not local time."""
624
## TODO: Option to choose either original, utc or local timezone
625
revno = 1
626
precursor = None
627
for p in self.revision_history():
628
print '-' * 40
629
print 'revno:', revno
630
## TODO: Show hash if --id is given.
631
##print 'revision-hash:', p
632
rev = self.get_revision(p)
633
print 'committer:', rev.committer
634
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
635
show_timezone))
636
637
## opportunistic consistency check, same as check_patch_chaining
638
if rev.precursor != precursor:
639
bailout("mismatched precursor!")
640
641
print 'message:'
642
if not rev.message:
643
print ' (no message)'
644
else:
645
for l in rev.message.split('\n'):
646
print ' ' + l
647
648
revno += 1
649
precursor = p
650
651
652
653
def show_status(branch, show_all=False):
654
"""Display single-line status for non-ignored working files.
655
656
The list is show sorted in order by file name.
657
658
>>> b = ScratchBranch(files=['foo', 'foo~'])
659
>>> b.show_status()
660
? foo
661
>>> b.add('foo')
662
>>> b.show_status()
663
A foo
664
>>> b.commit("add foo")
665
>>> b.show_status()
666
667
:todo: Get state for single files.
668
669
:todo: Perhaps show a slash at the end of directory names.
670
671
"""
672
673
# We have to build everything into a list first so that it can
674
# sorted by name, incorporating all the different sources.
675
676
# FIXME: Rather than getting things in random order and then sorting,
677
# just step through in order.
678
679
# Interesting case: the old ID for a file has been removed,
680
# but a new file has been created under that name.
681
682
old = branch.basis_tree()
683
old_inv = old.inventory
684
new = branch.working_tree()
685
new_inv = new.inventory
686
687
for fs, fid, oldname, newname, kind in diff_trees(old, new):
688
if fs == 'R':
689
show_status(fs, kind,
690
oldname + ' => ' + newname)
691
elif fs == 'A' or fs == 'M':
692
show_status(fs, kind, newname)
693
elif fs == 'D':
694
show_status(fs, kind, oldname)
695
elif fs == '.':
696
if show_all:
697
show_status(fs, kind, newname)
698
elif fs == 'I':
699
if show_all:
700
show_status(fs, kind, newname)
701
elif fs == '?':
702
show_status(fs, kind, newname)
703
else:
704
bailout("wierd file state %r" % ((fs, fid),))
705
603
def rename_one(self, from_rel, to_rel):
604
"""Rename one file.
605
606
This can change the directory or the filename or both.
607
"""
608
self._need_writelock()
609
tree = self.working_tree()
610
inv = tree.inventory
611
if not tree.has_filename(from_rel):
612
bailout("can't rename: old working file %r does not exist" % from_rel)
613
if tree.has_filename(to_rel):
614
bailout("can't rename: new working file %r already exists" % to_rel)
615
616
file_id = inv.path2id(from_rel)
617
if file_id == None:
618
bailout("can't rename: old name %r is not versioned" % from_rel)
619
620
if inv.path2id(to_rel):
621
bailout("can't rename: new name %r is already versioned" % to_rel)
622
623
to_dir, to_tail = os.path.split(to_rel)
624
to_dir_id = inv.path2id(to_dir)
625
if to_dir_id == None and to_dir != '':
626
bailout("can't determine destination directory id for %r" % to_dir)
627
628
mutter("rename_one:")
629
mutter(" file_id {%s}" % file_id)
630
mutter(" from_rel %r" % from_rel)
631
mutter(" to_rel %r" % to_rel)
632
mutter(" to_dir %r" % to_dir)
633
mutter(" to_dir_id {%s}" % to_dir_id)
634
635
inv.rename(file_id, to_dir_id, to_tail)
636
637
print "%s => %s" % (from_rel, to_rel)
638
639
from_abs = self.abspath(from_rel)
640
to_abs = self.abspath(to_rel)
641
try:
642
os.rename(from_abs, to_abs)
643
except OSError, e:
644
bailout("failed to rename %r to %r: %s"
645
% (from_abs, to_abs, e[1]),
646
["rename rolled back"])
647
648
self._write_inventory(inv)
649
650
651
652
def move(self, from_paths, to_name):
653
"""Rename files.
654
655
to_name must exist as a versioned directory.
656
657
If to_name exists and is a directory, the files are moved into
658
it, keeping their old names. If it is a directory,
659
660
Note that to_name is only the last component of the new name;
661
this doesn't change the directory.
662
"""
663
self._need_writelock()
664
## TODO: Option to move IDs only
665
assert not isinstance(from_paths, basestring)
666
tree = self.working_tree()
667
inv = tree.inventory
668
to_abs = self.abspath(to_name)
669
if not isdir(to_abs):
670
bailout("destination %r is not a directory" % to_abs)
671
if not tree.has_filename(to_name):
672
bailout("destination %r not in working directory" % to_abs)
673
to_dir_id = inv.path2id(to_name)
674
if to_dir_id == None and to_name != '':
675
bailout("destination %r is not a versioned directory" % to_name)
676
to_dir_ie = inv[to_dir_id]
677
if to_dir_ie.kind not in ('directory', 'root_directory'):
678
bailout("destination %r is not a directory" % to_abs)
679
680
to_idpath = inv.get_idpath(to_dir_id)
681
682
for f in from_paths:
683
if not tree.has_filename(f):
684
bailout("%r does not exist in working tree" % f)
685
f_id = inv.path2id(f)
686
if f_id == None:
687
bailout("%r is not versioned" % f)
688
name_tail = splitpath(f)[-1]
689
dest_path = appendpath(to_name, name_tail)
690
if tree.has_filename(dest_path):
691
bailout("destination %r already exists" % dest_path)
692
if f_id in to_idpath:
693
bailout("can't move %r to a subdirectory of itself" % f)
694
695
# OK, so there's a race here, it's possible that someone will
696
# create a file in this interval and then the rename might be
697
# left half-done. But we should have caught most problems.
698
699
for f in from_paths:
700
name_tail = splitpath(f)[-1]
701
dest_path = appendpath(to_name, name_tail)
702
print "%s => %s" % (f, dest_path)
703
inv.rename(inv.path2id(f), to_dir_id, name_tail)
704
try:
705
os.rename(self.abspath(f), self.abspath(dest_path))
706
except OSError, e:
707
bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
708
["rename rolled back"])
709
710
self._write_inventory(inv)
711
712
706
713
707
714
708
715
class ScratchBranch(Branch):
712
719
>>> isdir(b.base)
713
720
True
714
721
>>> bd = b.base
715
>>> del b
722
>>> b.destroy()
716
723
>>> isdir(bd)
717
724
False
718
725
"""
719
def __init__(self, files = []):
726
def __init__(self, files=[], dirs=[]):
720
727
"""Make a test branch.
721
728
722
729
This creates a temporary directory and runs init-tree in it.
724
731
If any files are listed, they are created in the working copy.
725
732
"""
726
733
Branch.__init__(self, tempfile.mkdtemp(), init=True)
734
for d in dirs:
735
os.mkdir(self.abspath(d))
736
727
737
for f in files:
728
738
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
729
739
730
740
731
741
def __del__(self):
742
self.destroy()
743
744
def destroy(self):
732
745
"""Destroy the test branch, removing the scratch directory."""
733
shutil.rmtree(self.base)
746
try:
747
mutter("delete ScratchBranch %s" % self.base)
748
shutil.rmtree(self.base)
749
except OSError, e:
750
# Work around for shutil.rmtree failing on Windows when
751
# readonly files are encountered
752
mutter("hit exception in destroying ScratchBranch: %s" % e)
753
for root, dirs, files in os.walk(self.base, topdown=False):
754
for name in files:
755
os.chmod(os.path.join(root, name), 0700)
756
shutil.rmtree(self.base)
757
self.base = None
734
758
735
759
736
760
746
770
## mutter('check %r for control file' % ((head, tail), ))
747
771
if tail == bzrlib.BZRDIR:
748
772
return True
773
if filename == head:
774
break
749
775
filename = head
750
776
return False
751
777
752
778
753
779
754
def _gen_revision_id(when):
755
"""Return new revision-id."""
756
s = '%s-%s-' % (user_email(), compact_date(when))
757
s += hexlify(rand_bytes(8))
758
return s
759
760
761
def _gen_file_id(name):
780
def gen_file_id(name):
762
781
"""Return new file id.
763
782
764
783
This should probably generate proper UUIDs, but for the moment we
765
784
cope with just randomness because running uuidgen every time is
766
785
slow."""
767
assert '/' not in name
768
while name[0] == '.':
769
name = name[1:]
786
import re
787
788
# get last component
789
idx = name.rfind('/')
790
if idx != -1:
791
name = name[idx+1 : ]
792
idx = name.rfind('\\')
793
if idx != -1:
794
name = name[idx+1 : ]
795
796
# make it not a hidden file
797
name = name.lstrip('.')
798
799
# remove any wierd characters; we don't escape them but rather
800
# just pull them out
801
name = re.sub(r'[^\w.]', '', name)
802
770
803
s = hexlify(rand_bytes(8))
771
804
return '-'.join((name, compact_date(time.time()), s))
772
773
Loggerhead is a web-based interface for Breezy
Version: 2.0.1