« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 630
- compare with another revision
- download diff
- download tarball
- view history from revision 630
- Committer: Martin Pool
- Date: 2005-06-06 12:31:16 UTC
- Revision ID: mbp@sourcefrog.net-20050606123116-13682013713da7fa
- don't ignore .diff files in bzr tree
- files added:
- .rsyncexclude
- contrib
- contrib/bash
- contrib/zsh
- elementtree
- patches
- urlgrabber
- files removed:
- bzrlib/tests.py
- files renamed:
- bzr.py => bzrlib/commands.py
- files modified:
- .bzrignore
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 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
44
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
49
def _relpath(base, path):
50
"""Return path relative to base, or raise exception.
51
52
The path may be either an absolute path or a path relative to the
53
current working directory.
54
55
Lifted out of Branch.relpath for ease of testing.
56
57
os.path.commonprefix (python2.4) has a bad bug that it works just
58
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
59
avoids that problem."""
60
rp = os.path.abspath(path)
61
62
s = []
63
head = rp
64
while len(head) >= len(base):
65
if head == base:
66
break
67
head, tail = os.path.split(head)
68
if tail:
69
s.insert(0, tail)
70
else:
71
from errors import NotBranchError
72
raise NotBranchError("path %r is not within branch %r" % (rp, base))
73
74
return os.sep.join(s)
75
76
77
def find_branch_root(f=None):
78
"""Find the branch root enclosing f, or pwd.
79
80
f may be a filename or a URL.
81
82
It is not necessary that f exists.
83
84
Basically we keep looking up until we find the control directory or
85
run into the root."""
86
if f == None:
87
f = os.getcwd()
88
elif hasattr(os.path, 'realpath'):
89
f = os.path.realpath(f)
90
else:
91
f = os.path.abspath(f)
92
if not os.path.exists(f):
93
raise BzrError('%r does not exist' % f)
94
95
96
orig_f = f
97
98
while True:
99
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
100
return f
101
head, tail = os.path.split(f)
102
if head == f:
103
# reached the root, whatever that may be
104
raise BzrError('%r is not in a branch' % orig_f)
105
f = head
106
107
class DivergedBranches(Exception):
108
def __init__(self, branch1, branch2):
109
self.branch1 = branch1
110
self.branch2 = branch2
111
Exception.__init__(self, "These branches have diverged.")
45
112
46
113
######################################################################
47
114
# branch objects
48
115
49
class Branch:
116
class Branch(object):
50
117
"""Branch holding a history of revisions.
51
118
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.
119
base
120
Base directory of the branch.
121
122
_lock_mode
123
None, or 'r' or 'w'
124
125
_lock_count
126
If _lock_mode is true, a positive count of the number of times the
127
lock has been taken.
128
129
_lock
130
Lock object from bzrlib.lock.
64
131
"""
65
def __init__(self, base, init=False):
132
base = None
133
_lock_mode = None
134
_lock_count = None
135
_lock = None
136
137
def __init__(self, base, init=False, find_root=True):
66
138
"""Create new branch object at a particular location.
67
139
68
:param base: Base directory for the branch.
69
70
:param init: If True, create new control files in a previously
140
base -- Base directory for the branch.
141
142
init -- If True, create new control files in a previously
71
143
unversioned directory. If False, the branch must already
72
144
be versioned.
73
145
146
find_root -- If true and init is false, find the root of the
147
existing branch containing base.
148
74
149
In the test suite, creation of new trees is tested using the
75
150
`ScratchBranch` class.
76
151
"""
77
self.base = os.path.realpath(base)
78
152
if init:
153
self.base = os.path.realpath(base)
79
154
self._make_control()
155
elif find_root:
156
self.base = find_branch_root(base)
80
157
else:
158
self.base = os.path.realpath(base)
81
159
if not isdir(self.controlfilename('.')):
82
bailout("not a bzr branch: %s" % quotefn(base),
83
['use "bzr init" to initialize a new working tree',
84
'current bzr can only operate from top-of-tree'])
85
self._check_format()
160
from errors import NotBranchError
161
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
162
['use "bzr init" to initialize a new working tree',
163
'current bzr can only operate from top-of-tree'])
164
self._check_format()
86
165
87
166
self.text_store = ImmutableStore(self.controlfilename('text-store'))
88
167
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
96
175
__repr__ = __str__
97
176
98
177
99
def _rel(self, name):
100
"""Return filename relative to branch top"""
178
def __del__(self):
179
if self._lock_mode or self._lock:
180
from warnings import warn
181
warn("branch %r was not explicitly unlocked" % self)
182
self._lock.unlock()
183
184
185
186
def lock_write(self):
187
if self._lock_mode:
188
if self._lock_mode != 'w':
189
from errors import LockError
190
raise LockError("can't upgrade to a write lock from %r" %
191
self._lock_mode)
192
self._lock_count += 1
193
else:
194
from bzrlib.lock import WriteLock
195
196
self._lock = WriteLock(self.controlfilename('branch-lock'))
197
self._lock_mode = 'w'
198
self._lock_count = 1
199
200
201
202
def lock_read(self):
203
if self._lock_mode:
204
assert self._lock_mode in ('r', 'w'), \
205
"invalid lock mode %r" % self._lock_mode
206
self._lock_count += 1
207
else:
208
from bzrlib.lock import ReadLock
209
210
self._lock = ReadLock(self.controlfilename('branch-lock'))
211
self._lock_mode = 'r'
212
self._lock_count = 1
213
214
215
216
def unlock(self):
217
if not self._lock_mode:
218
from errors import LockError
219
raise LockError('branch %r is not locked' % (self))
220
221
if self._lock_count > 1:
222
self._lock_count -= 1
223
else:
224
self._lock.unlock()
225
self._lock = None
226
self._lock_mode = self._lock_count = None
227
228
229
def abspath(self, name):
230
"""Return absolute filename for something in the branch"""
101
231
return os.path.join(self.base, name)
102
232
233
234
def relpath(self, path):
235
"""Return path relative to this branch of something inside it.
236
237
Raises an error if path is not in this branch."""
238
return _relpath(self.base, path)
239
103
240
104
241
def controlfilename(self, file_or_path):
105
242
"""Return location relative to branch."""
109
246
110
247
111
248
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)
249
"""Open a control file for this branch.
250
251
There are two classes of file in the control directory: text
252
and binary. binary files are untranslated byte streams. Text
253
control files are stored with Unix newlines and in UTF-8, even
254
if the platform or locale defaults are different.
255
256
Controlfiles should almost never be opened in write mode but
257
rather should be atomically copied and replaced using atomicfile.
258
"""
259
260
fn = self.controlfilename(file_or_path)
261
262
if mode == 'rb' or mode == 'wb':
263
return file(fn, mode)
264
elif mode == 'r' or mode == 'w':
265
# open in binary mode anyhow so there's no newline translation;
266
# codecs uses line buffering by default; don't want that.
267
import codecs
268
return codecs.open(fn, mode + 'b', 'utf-8',
269
buffering=60000)
270
else:
271
raise BzrError("invalid controlfile mode %r" % mode)
272
114
273
115
274
116
275
def _make_control(self):
122
281
for d in ('text-store', 'inventory-store', 'revision-store'):
123
282
os.mkdir(self.controlfilename(d))
124
283
for f in ('revision-history', 'merged-patches',
125
'pending-merged-patches', 'branch-name'):
284
'pending-merged-patches', 'branch-name',
285
'branch-lock'):
126
286
self.controlfile(f, 'w').write('')
127
287
mutter('created control directory in ' + self.base)
128
288
Inventory().write_xml(self.controlfile('inventory','w'))
135
295
136
296
In the future, we might need different in-memory Branch
137
297
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()
298
"""
299
# This ignores newlines so that we can open branches created
300
# on Windows from Linux and so on. I think it might be better
301
# to always make all internal files in unix format.
302
fmt = self.controlfile('branch-format', 'r').read()
303
fmt.replace('\r\n', '')
141
304
if fmt != BZR_BRANCH_FORMAT:
142
bailout('sorry, branch format %r not supported' % fmt,
143
['use a different bzr version',
144
'or remove the .bzr directory and "bzr init" again'])
305
raise BzrError('sorry, branch format %r not supported' % fmt,
306
['use a different bzr version',
307
'or remove the .bzr directory and "bzr init" again'])
308
145
309
146
310
147
311
def read_working_inventory(self):
148
312
"""Read the working inventory."""
149
313
before = time.time()
150
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
151
mutter("loaded inventory of %d items in %f"
152
% (len(inv), time.time() - before))
153
return inv
154
314
# ElementTree does its own conversion from UTF-8, so open in
315
# binary.
316
self.lock_read()
317
try:
318
inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
319
mutter("loaded inventory of %d items in %f"
320
% (len(inv), time.time() - before))
321
return inv
322
finally:
323
self.unlock()
324
155
325
156
326
def _write_inventory(self, inv):
157
327
"""Update the working inventory.
160
330
will be committed to the next revision.
161
331
"""
162
332
## TODO: factor out to atomicfile? is rename safe on windows?
333
## TODO: Maybe some kind of clean/dirty marker on inventory?
163
334
tmpfname = self.controlfilename('inventory.tmp')
164
tmpf = file(tmpfname, 'w')
335
tmpf = file(tmpfname, 'wb')
165
336
inv.write_xml(tmpf)
166
337
tmpf.close()
167
os.rename(tmpfname, self.controlfilename('inventory'))
338
inv_fname = self.controlfilename('inventory')
339
if sys.platform == 'win32':
340
os.remove(inv_fname)
341
os.rename(tmpfname, inv_fname)
168
342
mutter('wrote working inventory')
169
343
170
344
171
345
inventory = property(read_working_inventory, _write_inventory, None,
172
346
"""Inventory for the working copy.""")
173
347
174
348
175
def add(self, files, verbose=False):
349
def add(self, files, verbose=False, ids=None):
176
350
"""Make files versioned.
177
351
352
Note that the command line normally calls smart_add instead.
353
178
354
This puts the files in the Added state, so that they will be
179
355
recorded by the next commit.
180
356
181
:todo: Perhaps have an option to add the ids even if the files do
182
not (yet) exist.
183
184
:todo: Perhaps return the ids of the files? But then again it
185
is easy to retrieve them if they're needed.
186
187
:todo: Option to specify file id.
188
189
:todo: Adding a directory should optionally recurse down and
190
add all non-ignored children. Perhaps do that in a
191
higher-level method.
192
193
>>> b = ScratchBranch(files=['foo'])
194
>>> 'foo' in b.unknowns()
195
True
196
>>> b.show_status()
197
? foo
198
>>> b.add('foo')
199
>>> 'foo' in b.unknowns()
200
False
201
>>> bool(b.inventory.path2id('foo'))
202
True
203
>>> b.show_status()
204
A foo
205
206
>>> b.add('foo')
207
Traceback (most recent call last):
208
...
209
BzrError: ('foo is already versioned', [])
210
211
>>> b.add(['nothere'])
212
Traceback (most recent call last):
213
BzrError: ('cannot add: not a regular file or directory: nothere', [])
357
files
358
List of paths to add, relative to the base of the tree.
359
360
ids
361
If set, use these instead of automatically generated ids.
362
Must be the same length as the list of files, but may
363
contain None for ids that are to be autogenerated.
364
365
TODO: Perhaps have an option to add the ids even if the files do
366
not (yet) exist.
367
368
TODO: Perhaps return the ids of the files? But then again it
369
is easy to retrieve them if they're needed.
370
371
TODO: Adding a directory should optionally recurse down and
372
add all non-ignored children. Perhaps do that in a
373
higher-level method.
214
374
"""
215
216
375
# TODO: Re-adding a file that is removed in the working copy
217
376
# should probably put it back with the previous ID.
218
377
if isinstance(files, types.StringTypes):
378
assert(ids is None or isinstance(ids, types.StringTypes))
219
379
files = [files]
220
221
inv = self.read_working_inventory()
222
for f in files:
223
if is_control_file(f):
224
bailout("cannot add control file %s" % quotefn(f))
225
226
fp = splitpath(f)
227
228
if len(fp) == 0:
229
bailout("cannot add top-level %r" % f)
230
231
fullpath = os.path.normpath(self._rel(f))
232
233
if isfile(fullpath):
234
kind = 'file'
235
elif isdir(fullpath):
236
kind = 'directory'
237
else:
238
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
239
240
if len(fp) > 1:
241
parent_name = joinpath(fp[:-1])
242
mutter("lookup parent %r" % parent_name)
243
parent_id = inv.path2id(parent_name)
244
if parent_id == None:
245
bailout("cannot add: parent %r is not versioned"
246
% joinpath(fp[:-1]))
247
else:
248
parent_id = None
249
250
file_id = _gen_file_id(fp[-1])
251
inv.add(InventoryEntry(file_id, fp[-1], kind=kind, parent_id=parent_id))
252
if verbose:
253
show_status('A', kind, quotefn(f))
254
255
mutter("add file %s file_id:{%s} kind=%r parent_id={%s}"
256
% (f, file_id, kind, parent_id))
257
self._write_inventory(inv)
258
380
if ids is not None:
381
ids = [ids]
382
383
if ids is None:
384
ids = [None] * len(files)
385
else:
386
assert(len(ids) == len(files))
387
388
self.lock_write()
389
try:
390
inv = self.read_working_inventory()
391
for f,file_id in zip(files, ids):
392
if is_control_file(f):
393
raise BzrError("cannot add control file %s" % quotefn(f))
394
395
fp = splitpath(f)
396
397
if len(fp) == 0:
398
raise BzrError("cannot add top-level %r" % f)
399
400
fullpath = os.path.normpath(self.abspath(f))
401
402
try:
403
kind = file_kind(fullpath)
404
except OSError:
405
# maybe something better?
406
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
407
408
if kind != 'file' and kind != 'directory':
409
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
410
411
if file_id is None:
412
file_id = gen_file_id(f)
413
inv.add_path(f, kind=kind, file_id=file_id)
414
415
if verbose:
416
show_status('A', kind, quotefn(f))
417
418
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
419
420
self._write_inventory(inv)
421
finally:
422
self.unlock()
423
424
425
def print_file(self, file, revno):
426
"""Print `file` to stdout."""
427
self.lock_read()
428
try:
429
tree = self.revision_tree(self.lookup_revision(revno))
430
# use inventory as it was in that revision
431
file_id = tree.inventory.path2id(file)
432
if not file_id:
433
raise BzrError("%r is not present in revision %d" % (file, revno))
434
tree.print_file(file_id)
435
finally:
436
self.unlock()
259
437
260
438
261
439
def remove(self, files, verbose=False):
263
441
264
442
This does not remove their text. This does not run on
265
443
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
444
TODO: Refuse to remove modified files unless --force is given?
445
446
TODO: Do something useful with directories.
447
448
TODO: Should this remove the text or not? Tough call; not
293
449
removing may be useful and the user can just use use rm, and
294
450
is the opposite of add. Removing it is consistent with most
295
451
other tools. Maybe an option.
296
452
"""
297
453
## TODO: Normalize names
298
454
## TODO: Remove nested loops; better scalability
299
300
455
if isinstance(files, types.StringTypes):
301
456
files = [files]
302
303
inv = self.read_working_inventory()
304
305
# do this before any modifications
306
for f in files:
307
fid = inv.path2id(f)
308
if not fid:
309
bailout("cannot remove unversioned file %s" % quotefn(f))
310
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
311
if verbose:
312
show_status('D', inv[fid].kind, quotefn(f))
313
del inv[fid]
314
457
458
self.lock_write()
459
460
try:
461
tree = self.working_tree()
462
inv = tree.inventory
463
464
# do this before any modifications
465
for f in files:
466
fid = inv.path2id(f)
467
if not fid:
468
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
469
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
470
if verbose:
471
# having remove it, it must be either ignored or unknown
472
if tree.is_ignored(f):
473
new_status = 'I'
474
else:
475
new_status = '?'
476
show_status(new_status, inv[fid].kind, quotefn(f))
477
del inv[fid]
478
479
self._write_inventory(inv)
480
finally:
481
self.unlock()
482
483
484
# FIXME: this doesn't need to be a branch method
485
def set_inventory(self, new_inventory_list):
486
inv = Inventory()
487
for path, file_id, parent, kind in new_inventory_list:
488
name = os.path.basename(path)
489
if name == "":
490
continue
491
inv.add(InventoryEntry(file_id, name, kind, parent))
315
492
self._write_inventory(inv)
316
493
317
494
334
511
return self.working_tree().unknowns()
335
512
336
513
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!")
514
def append_revision(self, revision_id):
515
mutter("add {%s} to revision-history" % revision_id)
516
rev_history = self.revision_history()
517
518
tmprhname = self.controlfilename('revision-history.tmp')
519
rhname = self.controlfilename('revision-history')
520
521
f = file(tmprhname, 'wt')
522
rev_history.append(revision_id)
523
f.write('\n'.join(rev_history))
524
f.write('\n')
525
f.close()
526
527
if sys.platform == 'win32':
528
os.remove(rhname)
529
os.rename(tmprhname, rhname)
530
504
531
505
532
506
533
def get_revision(self, revision_id):
513
540
def get_inventory(self, inventory_id):
514
541
"""Get Inventory object by hash.
515
542
516
:todo: Perhaps for this and similar methods, take a revision
543
TODO: Perhaps for this and similar methods, take a revision
517
544
parameter which can be either an integer revno or a
518
545
string hash."""
519
546
i = Inventory.read_xml(self.inventory_store[inventory_id])
534
561
>>> ScratchBranch().revision_history()
535
562
[]
536
563
"""
537
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
564
self.lock_read()
565
try:
566
return [l.rstrip('\r\n') for l in
567
self.controlfile('revision-history', 'r').readlines()]
568
finally:
569
self.unlock()
570
571
572
def common_ancestor(self, other, self_revno=None, other_revno=None):
573
"""
574
>>> import commit
575
>>> sb = ScratchBranch(files=['foo', 'foo~'])
576
>>> sb.common_ancestor(sb) == (None, None)
577
True
578
>>> commit.commit(sb, "Committing first revision", verbose=False)
579
>>> sb.common_ancestor(sb)[0]
580
1
581
>>> clone = sb.clone()
582
>>> commit.commit(sb, "Committing second revision", verbose=False)
583
>>> sb.common_ancestor(sb)[0]
584
2
585
>>> sb.common_ancestor(clone)[0]
586
1
587
>>> commit.commit(clone, "Committing divergent second revision",
588
... verbose=False)
589
>>> sb.common_ancestor(clone)[0]
590
1
591
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
592
True
593
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
594
True
595
>>> clone2 = sb.clone()
596
>>> sb.common_ancestor(clone2)[0]
597
2
598
>>> sb.common_ancestor(clone2, self_revno=1)[0]
599
1
600
>>> sb.common_ancestor(clone2, other_revno=1)[0]
601
1
602
"""
603
my_history = self.revision_history()
604
other_history = other.revision_history()
605
if self_revno is None:
606
self_revno = len(my_history)
607
if other_revno is None:
608
other_revno = len(other_history)
609
indices = range(min((self_revno, other_revno)))
610
indices.reverse()
611
for r in indices:
612
if my_history[r] == other_history[r]:
613
return r+1, my_history[r]
614
return None, None
615
616
def enum_history(self, direction):
617
"""Return (revno, revision_id) for history of branch.
618
619
direction
620
'forward' is from earliest to latest
621
'reverse' is from latest to earliest
622
"""
623
rh = self.revision_history()
624
if direction == 'forward':
625
i = 1
626
for rid in rh:
627
yield i, rid
628
i += 1
629
elif direction == 'reverse':
630
i = len(rh)
631
while i > 0:
632
yield i, rh[i-1]
633
i -= 1
634
else:
635
raise ValueError('invalid history direction', direction)
538
636
539
637
540
638
def revno(self):
542
640
543
641
That is equivalent to the number of revisions committed to
544
642
this branch.
545
546
>>> b = ScratchBranch()
547
>>> b.revno()
548
0
549
>>> b.commit('no foo')
550
>>> b.revno()
551
1
552
643
"""
553
644
return len(self.revision_history())
554
645
555
646
556
647
def last_patch(self):
557
648
"""Return last patch hash, or None if no history.
558
559
>>> ScratchBranch().last_patch() == None
560
True
561
649
"""
562
650
ph = self.revision_history()
563
651
if ph:
564
652
return ph[-1]
565
653
else:
654
return None
655
656
657
def missing_revisions(self, other):
658
"""
659
If self and other have not diverged, return a list of the revisions
660
present in other, but missing from self.
661
662
>>> from bzrlib.commit import commit
663
>>> bzrlib.trace.silent = True
664
>>> br1 = ScratchBranch()
665
>>> br2 = ScratchBranch()
666
>>> br1.missing_revisions(br2)
667
[]
668
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
669
>>> br1.missing_revisions(br2)
670
[u'REVISION-ID-1']
671
>>> br2.missing_revisions(br1)
672
[]
673
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
674
>>> br1.missing_revisions(br2)
675
[]
676
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
677
>>> br1.missing_revisions(br2)
678
[u'REVISION-ID-2A']
679
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
680
>>> br1.missing_revisions(br2)
681
Traceback (most recent call last):
682
DivergedBranches: These branches have diverged.
683
"""
684
self_history = self.revision_history()
685
self_len = len(self_history)
686
other_history = other.revision_history()
687
other_len = len(other_history)
688
common_index = min(self_len, other_len) -1
689
if common_index >= 0 and \
690
self_history[common_index] != other_history[common_index]:
691
raise DivergedBranches(self, other)
692
if self_len < other_len:
693
return other_history[self_len:]
694
return []
695
696
697
def update_revisions(self, other):
698
"""If self and other have not diverged, ensure self has all the
699
revisions in other
700
701
>>> from bzrlib.commit import commit
702
>>> bzrlib.trace.silent = True
703
>>> br1 = ScratchBranch(files=['foo', 'bar'])
704
>>> br1.add('foo')
705
>>> br1.add('bar')
706
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
707
>>> br2 = ScratchBranch()
708
>>> br2.update_revisions(br1)
709
Added 2 texts.
710
Added 1 inventories.
711
Added 1 revisions.
712
>>> br2.revision_history()
713
[u'REVISION-ID-1']
714
>>> br2.update_revisions(br1)
715
Added 0 texts.
716
Added 0 inventories.
717
Added 0 revisions.
718
>>> br1.text_store.total_size() == br2.text_store.total_size()
719
True
720
"""
721
revision_ids = self.missing_revisions(other)
722
revisions = [other.get_revision(f) for f in revision_ids]
723
needed_texts = sets.Set()
724
for rev in revisions:
725
inv = other.get_inventory(str(rev.inventory_id))
726
for key, entry in inv.iter_entries():
727
if entry.text_id is None:
728
continue
729
if entry.text_id not in self.text_store:
730
needed_texts.add(entry.text_id)
731
count = self.text_store.copy_multi(other.text_store, needed_texts)
732
print "Added %d texts." % count
733
inventory_ids = [ f.inventory_id for f in revisions ]
734
count = self.inventory_store.copy_multi(other.inventory_store,
735
inventory_ids)
736
print "Added %d inventories." % count
737
revision_ids = [ f.revision_id for f in revisions]
738
count = self.revision_store.copy_multi(other.revision_store,
739
revision_ids)
740
for revision_id in revision_ids:
741
self.append_revision(revision_id)
742
print "Added %d revisions." % count
743
744
745
def commit(self, *args, **kw):
746
"""Deprecated"""
747
from bzrlib.commit import commit
748
commit(self, *args, **kw)
749
566
750
567
751
def lookup_revision(self, revno):
568
752
"""Return revision hash for revision number."""
573
757
# list is 0-based; revisions are 1-based
574
758
return self.revision_history()[revno-1]
575
759
except IndexError:
576
bailout("no such revision %s" % revno)
760
raise BzrError("no such revision %s" % revno)
577
761
578
762
579
763
def revision_tree(self, revision_id):
581
765
582
766
`revision_id` may be None for the null revision, in which case
583
767
an `EmptyTree` is returned."""
584
768
# TODO: refactor this to use an existing revision object
769
# so we don't need to read it in twice.
585
770
if revision_id == None:
586
771
return EmptyTree()
587
772
else:
591
776
592
777
def working_tree(self):
593
778
"""Return a `Tree` for the working copy."""
779
from workingtree import WorkingTree
594
780
return WorkingTree(self.base, self.read_working_inventory())
595
781
596
782
598
784
"""Return `Tree` object for last revision.
599
785
600
786
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
787
"""
612
788
r = self.last_patch()
613
789
if r == None:
617
793
618
794
619
795
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
>>> os.unlink(b._rel('foo'))
667
>>> b.show_status()
668
D foo
669
670
671
:todo: Get state for single files.
672
673
:todo: Perhaps show a slash at the end of directory names.
674
675
"""
676
677
# We have to build everything into a list first so that it can
678
# sorted by name, incorporating all the different sources.
679
680
# FIXME: Rather than getting things in random order and then sorting,
681
# just step through in order.
682
683
# Interesting case: the old ID for a file has been removed,
684
# but a new file has been created under that name.
685
686
old = branch.basis_tree()
687
old_inv = old.inventory
688
new = branch.working_tree()
689
new_inv = new.inventory
690
691
for fs, fid, oldname, newname, kind in diff_trees(old, new):
692
if fs == 'R':
693
show_status(fs, kind,
694
oldname + ' => ' + newname)
695
elif fs == 'A' or fs == 'M':
696
show_status(fs, kind, newname)
697
elif fs == 'D':
698
show_status(fs, kind, oldname)
699
elif fs == '.':
700
if show_all:
701
show_status(fs, kind, newname)
702
elif fs == 'I':
703
if show_all:
704
show_status(fs, kind, newname)
705
elif fs == '?':
706
show_status(fs, kind, newname)
707
else:
708
bailout("wierd file state %r" % ((fs, fid),))
709
796
def rename_one(self, from_rel, to_rel):
797
"""Rename one file.
798
799
This can change the directory or the filename or both.
800
"""
801
self.lock_write()
802
try:
803
tree = self.working_tree()
804
inv = tree.inventory
805
if not tree.has_filename(from_rel):
806
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
807
if tree.has_filename(to_rel):
808
raise BzrError("can't rename: new working file %r already exists" % to_rel)
809
810
file_id = inv.path2id(from_rel)
811
if file_id == None:
812
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
813
814
if inv.path2id(to_rel):
815
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
816
817
to_dir, to_tail = os.path.split(to_rel)
818
to_dir_id = inv.path2id(to_dir)
819
if to_dir_id == None and to_dir != '':
820
raise BzrError("can't determine destination directory id for %r" % to_dir)
821
822
mutter("rename_one:")
823
mutter(" file_id {%s}" % file_id)
824
mutter(" from_rel %r" % from_rel)
825
mutter(" to_rel %r" % to_rel)
826
mutter(" to_dir %r" % to_dir)
827
mutter(" to_dir_id {%s}" % to_dir_id)
828
829
inv.rename(file_id, to_dir_id, to_tail)
830
831
print "%s => %s" % (from_rel, to_rel)
832
833
from_abs = self.abspath(from_rel)
834
to_abs = self.abspath(to_rel)
835
try:
836
os.rename(from_abs, to_abs)
837
except OSError, e:
838
raise BzrError("failed to rename %r to %r: %s"
839
% (from_abs, to_abs, e[1]),
840
["rename rolled back"])
841
842
self._write_inventory(inv)
843
finally:
844
self.unlock()
845
846
847
def move(self, from_paths, to_name):
848
"""Rename files.
849
850
to_name must exist as a versioned directory.
851
852
If to_name exists and is a directory, the files are moved into
853
it, keeping their old names. If it is a directory,
854
855
Note that to_name is only the last component of the new name;
856
this doesn't change the directory.
857
"""
858
self.lock_write()
859
try:
860
## TODO: Option to move IDs only
861
assert not isinstance(from_paths, basestring)
862
tree = self.working_tree()
863
inv = tree.inventory
864
to_abs = self.abspath(to_name)
865
if not isdir(to_abs):
866
raise BzrError("destination %r is not a directory" % to_abs)
867
if not tree.has_filename(to_name):
868
raise BzrError("destination %r not in working directory" % to_abs)
869
to_dir_id = inv.path2id(to_name)
870
if to_dir_id == None and to_name != '':
871
raise BzrError("destination %r is not a versioned directory" % to_name)
872
to_dir_ie = inv[to_dir_id]
873
if to_dir_ie.kind not in ('directory', 'root_directory'):
874
raise BzrError("destination %r is not a directory" % to_abs)
875
876
to_idpath = inv.get_idpath(to_dir_id)
877
878
for f in from_paths:
879
if not tree.has_filename(f):
880
raise BzrError("%r does not exist in working tree" % f)
881
f_id = inv.path2id(f)
882
if f_id == None:
883
raise BzrError("%r is not versioned" % f)
884
name_tail = splitpath(f)[-1]
885
dest_path = appendpath(to_name, name_tail)
886
if tree.has_filename(dest_path):
887
raise BzrError("destination %r already exists" % dest_path)
888
if f_id in to_idpath:
889
raise BzrError("can't move %r to a subdirectory of itself" % f)
890
891
# OK, so there's a race here, it's possible that someone will
892
# create a file in this interval and then the rename might be
893
# left half-done. But we should have caught most problems.
894
895
for f in from_paths:
896
name_tail = splitpath(f)[-1]
897
dest_path = appendpath(to_name, name_tail)
898
print "%s => %s" % (f, dest_path)
899
inv.rename(inv.path2id(f), to_dir_id, name_tail)
900
try:
901
os.rename(self.abspath(f), self.abspath(dest_path))
902
except OSError, e:
903
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
904
["rename rolled back"])
905
906
self._write_inventory(inv)
907
finally:
908
self.unlock()
909
710
910
711
911
712
912
class ScratchBranch(Branch):
716
916
>>> isdir(b.base)
717
917
True
718
918
>>> bd = b.base
719
>>> del b
919
>>> b.destroy()
720
920
>>> isdir(bd)
721
921
False
722
922
"""
723
def __init__(self, files = []):
923
def __init__(self, files=[], dirs=[], base=None):
724
924
"""Make a test branch.
725
925
726
926
This creates a temporary directory and runs init-tree in it.
727
927
728
928
If any files are listed, they are created in the working copy.
729
929
"""
730
Branch.__init__(self, tempfile.mkdtemp(), init=True)
930
init = False
931
if base is None:
932
base = tempfile.mkdtemp()
933
init = True
934
Branch.__init__(self, base, init=init)
935
for d in dirs:
936
os.mkdir(self.abspath(d))
937
731
938
for f in files:
732
939
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
733
940
734
941
942
def clone(self):
943
"""
944
>>> orig = ScratchBranch(files=["file1", "file2"])
945
>>> clone = orig.clone()
946
>>> os.path.samefile(orig.base, clone.base)
947
False
948
>>> os.path.isfile(os.path.join(clone.base, "file1"))
949
True
950
"""
951
base = tempfile.mkdtemp()
952
os.rmdir(base)
953
shutil.copytree(self.base, base, symlinks=True)
954
return ScratchBranch(base=base)
955
735
956
def __del__(self):
957
self.destroy()
958
959
def destroy(self):
736
960
"""Destroy the test branch, removing the scratch directory."""
737
shutil.rmtree(self.base)
961
try:
962
if self.base:
963
mutter("delete ScratchBranch %s" % self.base)
964
shutil.rmtree(self.base)
965
except OSError, e:
966
# Work around for shutil.rmtree failing on Windows when
967
# readonly files are encountered
968
mutter("hit exception in destroying ScratchBranch: %s" % e)
969
for root, dirs, files in os.walk(self.base, topdown=False):
970
for name in files:
971
os.chmod(os.path.join(root, name), 0700)
972
shutil.rmtree(self.base)
973
self.base = None
738
974
739
975
740
976
750
986
## mutter('check %r for control file' % ((head, tail), ))
751
987
if tail == bzrlib.BZRDIR:
752
988
return True
989
if filename == head:
990
break
753
991
filename = head
754
992
return False
755
993
756
994
757
995
758
def _gen_revision_id(when):
759
"""Return new revision-id."""
760
s = '%s-%s-' % (user_email(), compact_date(when))
761
s += hexlify(rand_bytes(8))
762
return s
763
764
765
def _gen_file_id(name):
996
def gen_file_id(name):
766
997
"""Return new file id.
767
998
768
999
This should probably generate proper UUIDs, but for the moment we
769
1000
cope with just randomness because running uuidgen every time is
770
1001
slow."""
771
assert '/' not in name
772
while name[0] == '.':
773
name = name[1:]
1002
import re
1003
1004
# get last component
1005
idx = name.rfind('/')
1006
if idx != -1:
1007
name = name[idx+1 : ]
1008
idx = name.rfind('\\')
1009
if idx != -1:
1010
name = name[idx+1 : ]
1011
1012
# make it not a hidden file
1013
name = name.lstrip('.')
1014
1015
# remove any wierd characters; we don't escape them but rather
1016
# just pull them out
1017
name = re.sub(r'[^\w.]', '', name)
1018
774
1019
s = hexlify(rand_bytes(8))
775
1020
return '-'.join((name, compact_date(time.time()), s))
776
777
Loggerhead is a web-based interface for Breezy
Version: 2.0.1