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