16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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
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, splitpath, \
24
sha_file, appendpath, file_kind
25
from bzrlib.errors import BzrError
26
from bzrlib.textui import show_status
39
28
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
40
29
## TODO: Maybe include checks for common corruption of newlines, etc?
33
def find_branch(f, **args):
34
if f and (f.startswith('http://') or f.startswith('https://')):
36
return remotebranch.RemoteBranch(f, **args)
38
return Branch(f, **args)
41
def find_cached_branch(f, cache_root, **args):
42
from remotebranch import RemoteBranch
43
br = find_branch(f, **args)
44
def cacheify(br, store_name):
45
from meta_store import CachedStore
46
cache_path = os.path.join(cache_root, store_name)
48
new_store = CachedStore(getattr(br, store_name), cache_path)
49
setattr(br, store_name, new_store)
51
if isinstance(br, RemoteBranch):
52
cacheify(br, 'inventory_store')
53
cacheify(br, 'text_store')
54
cacheify(br, 'revision_store')
58
def _relpath(base, path):
59
"""Return path relative to base, or raise exception.
61
The path may be either an absolute path or a path relative to the
62
current working directory.
64
Lifted out of Branch.relpath for ease of testing.
66
os.path.commonprefix (python2.4) has a bad bug that it works just
67
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
68
avoids that problem."""
69
rp = os.path.abspath(path)
73
while len(head) >= len(base):
76
head, tail = os.path.split(head)
80
from errors import NotBranchError
81
raise NotBranchError("path %r is not within branch %r" % (rp, base))
86
def find_branch_root(f=None):
87
"""Find the branch root enclosing f, or pwd.
89
f may be a filename or a URL.
91
It is not necessary that f exists.
93
Basically we keep looking up until we find the control directory or
97
elif hasattr(os.path, 'realpath'):
98
f = os.path.realpath(f)
100
f = os.path.abspath(f)
101
if not os.path.exists(f):
102
raise BzrError('%r does not exist' % f)
108
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
110
head, tail = os.path.split(f)
112
# reached the root, whatever that may be
113
raise BzrError('%r is not in a branch' % orig_f)
116
class DivergedBranches(Exception):
117
def __init__(self, branch1, branch2):
118
self.branch1 = branch1
119
self.branch2 = branch2
120
Exception.__init__(self, "These branches have diverged.")
123
class NoSuchRevision(BzrError):
124
def __init__(self, branch, revision):
126
self.revision = revision
127
msg = "Branch %s has no revision %d" % (branch, revision)
128
BzrError.__init__(self, msg)
46
131
######################################################################
134
class Branch(object):
50
135
"""Branch holding a history of revisions.
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.
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.
61
:todo: Keep the on-disk branch locked while the object exists.
63
:todo: mkdir() method.
138
Base directory of the branch.
144
If _lock_mode is true, a positive count of the number of times the
148
Lock object from bzrlib.lock.
65
def __init__(self, base, init=False):
155
# Map some sort of prefix into a namespace
156
# stuff like "revno:10", "revid:", etc.
157
# This should match a prefix with a function which accepts
158
REVISION_NAMESPACES = {}
160
def __init__(self, base, init=False, find_root=True):
66
161
"""Create new branch object at a particular location.
68
:param base: Base directory for the branch.
70
:param init: If True, create new control files in a previously
163
base -- Base directory for the branch.
165
init -- If True, create new control files in a previously
71
166
unversioned directory. If False, the branch must already
169
find_root -- If true and init is false, find the root of the
170
existing branch containing base.
74
172
In the test suite, creation of new trees is tested using the
75
173
`ScratchBranch` class.
77
self.base = os.path.realpath(base)
175
from bzrlib.store import ImmutableStore
177
self.base = os.path.realpath(base)
79
178
self._make_control()
180
self.base = find_branch_root(base)
182
self.base = os.path.realpath(base)
81
183
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'])
184
from errors import NotBranchError
185
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
186
['use "bzr init" to initialize a new working tree',
187
'current bzr can only operate from top-of-tree'])
87
190
self.text_store = ImmutableStore(self.controlfilename('text-store'))
88
191
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
96
199
__repr__ = __str__
100
"""Return filename relative to branch top"""
203
if self._lock_mode or self._lock:
204
from warnings import warn
205
warn("branch %r was not explicitly unlocked" % self)
210
def lock_write(self):
212
if self._lock_mode != 'w':
213
from errors import LockError
214
raise LockError("can't upgrade to a write lock from %r" %
216
self._lock_count += 1
218
from bzrlib.lock import WriteLock
220
self._lock = WriteLock(self.controlfilename('branch-lock'))
221
self._lock_mode = 'w'
228
assert self._lock_mode in ('r', 'w'), \
229
"invalid lock mode %r" % self._lock_mode
230
self._lock_count += 1
232
from bzrlib.lock import ReadLock
234
self._lock = ReadLock(self.controlfilename('branch-lock'))
235
self._lock_mode = 'r'
241
if not self._lock_mode:
242
from errors import LockError
243
raise LockError('branch %r is not locked' % (self))
245
if self._lock_count > 1:
246
self._lock_count -= 1
250
self._lock_mode = self._lock_count = None
253
def abspath(self, name):
254
"""Return absolute filename for something in the branch"""
101
255
return os.path.join(self.base, name)
258
def relpath(self, path):
259
"""Return path relative to this branch of something inside it.
261
Raises an error if path is not in this branch."""
262
return _relpath(self.base, path)
104
265
def controlfilename(self, file_or_path):
105
266
"""Return location relative to branch."""
106
if isinstance(file_or_path, types.StringTypes):
267
if isinstance(file_or_path, basestring):
107
268
file_or_path = [file_or_path]
108
269
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
111
272
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)
273
"""Open a control file for this branch.
275
There are two classes of file in the control directory: text
276
and binary. binary files are untranslated byte streams. Text
277
control files are stored with Unix newlines and in UTF-8, even
278
if the platform or locale defaults are different.
280
Controlfiles should almost never be opened in write mode but
281
rather should be atomically copied and replaced using atomicfile.
284
fn = self.controlfilename(file_or_path)
286
if mode == 'rb' or mode == 'wb':
287
return file(fn, mode)
288
elif mode == 'r' or mode == 'w':
289
# open in binary mode anyhow so there's no newline translation;
290
# codecs uses line buffering by default; don't want that.
292
return codecs.open(fn, mode + 'b', 'utf-8',
295
raise BzrError("invalid controlfile mode %r" % mode)
116
299
def _make_control(self):
300
from bzrlib.inventory import Inventory
301
from bzrlib.xml import pack_xml
117
303
os.mkdir(self.controlfilename([]))
118
304
self.controlfile('README', 'w').write(
119
305
"This is a Bazaar-NG control directory.\n"
120
"Do not change any files in this directory.")
306
"Do not change any files in this directory.\n")
121
307
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
122
308
for d in ('text-store', 'inventory-store', 'revision-store'):
123
309
os.mkdir(self.controlfilename(d))
124
310
for f in ('revision-history', 'merged-patches',
125
'pending-merged-patches', 'branch-name'):
311
'pending-merged-patches', 'branch-name',
126
314
self.controlfile(f, 'w').write('')
127
315
mutter('created control directory in ' + self.base)
128
Inventory().write_xml(self.controlfile('inventory','w'))
317
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
131
320
def _check_format(self):
136
325
In the future, we might need different in-memory Branch
137
326
classes to support downlevel branches. But not yet.
139
# read in binary mode to detect newline wierdness.
140
fmt = self.controlfile('branch-format', 'rb').read()
328
# This ignores newlines so that we can open branches created
329
# on Windows from Linux and so on. I think it might be better
330
# to always make all internal files in unix format.
331
fmt = self.controlfile('branch-format', 'r').read()
332
fmt.replace('\r\n', '')
141
333
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'])
334
raise BzrError('sorry, branch format %r not supported' % fmt,
335
['use a different bzr version',
336
'or remove the .bzr directory and "bzr init" again'])
338
def get_root_id(self):
339
"""Return the id of this branches root"""
340
inv = self.read_working_inventory()
341
return inv.root.file_id
343
def set_root_id(self, file_id):
344
inv = self.read_working_inventory()
345
orig_root_id = inv.root.file_id
346
del inv._byid[inv.root.file_id]
347
inv.root.file_id = file_id
348
inv._byid[inv.root.file_id] = inv.root
351
if entry.parent_id in (None, orig_root_id):
352
entry.parent_id = inv.root.file_id
353
self._write_inventory(inv)
147
355
def read_working_inventory(self):
148
356
"""Read the working inventory."""
150
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
151
mutter("loaded inventory of %d items in %f"
152
% (len(inv), time.time() - before))
357
from bzrlib.inventory import Inventory
358
from bzrlib.xml import unpack_xml
359
from time import time
363
# ElementTree does its own conversion from UTF-8, so open in
365
inv = unpack_xml(Inventory,
366
self.controlfile('inventory', 'rb'))
367
mutter("loaded inventory of %d items in %f"
368
% (len(inv), time() - before))
156
374
def _write_inventory(self, inv):
157
375
"""Update the working inventory.
159
377
That is to say, the inventory describing changes underway, that
160
378
will be committed to the next revision.
162
## TODO: factor out to atomicfile? is rename safe on windows?
163
tmpfname = self.controlfilename('inventory.tmp')
164
tmpf = file(tmpfname, 'w')
167
os.rename(tmpfname, self.controlfilename('inventory'))
380
from bzrlib.atomicfile import AtomicFile
381
from bzrlib.xml import pack_xml
385
f = AtomicFile(self.controlfilename('inventory'), 'wb')
168
394
mutter('wrote working inventory')
171
397
inventory = property(read_working_inventory, _write_inventory, None,
172
398
"""Inventory for the working copy.""")
175
def add(self, files, verbose=False):
401
def add(self, files, verbose=False, ids=None):
176
402
"""Make files versioned.
404
Note that the command line normally calls smart_add instead.
178
406
This puts the files in the Added state, so that they will be
179
407
recorded by the next commit.
181
:todo: Perhaps have an option to add the ids even if the files do
184
:todo: Perhaps return the ids of the files? But then again it
185
is easy to retrieve them if they're needed.
187
:todo: Option to specify file id.
189
:todo: Adding a directory should optionally recurse down and
190
add all non-ignored children. Perhaps do that in a
193
>>> b = ScratchBranch(files=['foo'])
194
>>> 'foo' in b.unknowns()
199
>>> 'foo' in b.unknowns()
201
>>> bool(b.inventory.path2id('foo'))
207
Traceback (most recent call last):
209
BzrError: ('foo is already versioned', [])
211
>>> b.add(['nothere'])
212
Traceback (most recent call last):
213
BzrError: ('cannot add: not a regular file or directory: nothere', [])
410
List of paths to add, relative to the base of the tree.
413
If set, use these instead of automatically generated ids.
414
Must be the same length as the list of files, but may
415
contain None for ids that are to be autogenerated.
417
TODO: Perhaps have an option to add the ids even if the files do
420
TODO: Perhaps return the ids of the files? But then again it
421
is easy to retrieve them if they're needed.
423
TODO: Adding a directory should optionally recurse down and
424
add all non-ignored children. Perhaps do that in a
216
427
# TODO: Re-adding a file that is removed in the working copy
217
428
# should probably put it back with the previous ID.
218
if isinstance(files, types.StringTypes):
429
if isinstance(files, basestring):
430
assert(ids is None or isinstance(ids, basestring))
221
inv = self.read_working_inventory()
223
if is_control_file(f):
224
bailout("cannot add control file %s" % quotefn(f))
229
bailout("cannot add top-level %r" % f)
231
fullpath = os.path.normpath(self._rel(f))
235
elif isdir(fullpath):
238
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
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"
250
file_id = _gen_file_id(fp[-1])
251
inv.add(InventoryEntry(file_id, fp[-1], kind=kind, parent_id=parent_id))
253
show_status('A', kind, quotefn(f))
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)
436
ids = [None] * len(files)
438
assert(len(ids) == len(files))
442
inv = self.read_working_inventory()
443
for f,file_id in zip(files, ids):
444
if is_control_file(f):
445
raise BzrError("cannot add control file %s" % quotefn(f))
450
raise BzrError("cannot add top-level %r" % f)
452
fullpath = os.path.normpath(self.abspath(f))
455
kind = file_kind(fullpath)
457
# maybe something better?
458
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
460
if kind != 'file' and kind != 'directory':
461
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
file_id = gen_file_id(f)
465
inv.add_path(f, kind=kind, file_id=file_id)
468
print 'added', quotefn(f)
470
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
472
self._write_inventory(inv)
477
def print_file(self, file, revno):
478
"""Print `file` to stdout."""
481
tree = self.revision_tree(self.lookup_revision(revno))
482
# use inventory as it was in that revision
483
file_id = tree.inventory.path2id(file)
485
raise BzrError("%r is not present in revision %s" % (file, revno))
486
tree.print_file(file_id)
261
491
def remove(self, files, verbose=False):
264
494
This does not remove their text. This does not run on
266
:todo: Refuse to remove modified files unless --force is given?
268
>>> b = ScratchBranch(files=['foo'])
270
>>> b.inventory.has_filename('foo')
273
>>> b.working_tree().has_filename('foo')
275
>>> b.inventory.has_filename('foo')
278
>>> b = ScratchBranch(files=['foo'])
283
>>> b.inventory.has_filename('foo')
285
>>> b.basis_tree().has_filename('foo')
287
>>> b.working_tree().has_filename('foo')
290
:todo: Do something useful with directories.
292
:todo: Should this remove the text or not? Tough call; not
496
TODO: Refuse to remove modified files unless --force is given?
498
TODO: Do something useful with directories.
500
TODO: Should this remove the text or not? Tough call; not
293
501
removing may be useful and the user can just use use rm, and
294
502
is the opposite of add. Removing it is consistent with most
295
503
other tools. Maybe an option.
297
505
## TODO: Normalize names
298
506
## TODO: Remove nested loops; better scalability
300
if isinstance(files, types.StringTypes):
507
if isinstance(files, basestring):
303
inv = self.read_working_inventory()
305
# do this before any modifications
309
bailout("cannot remove unversioned file %s" % quotefn(f))
310
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
312
show_status('D', inv[fid].kind, quotefn(f))
513
tree = self.working_tree()
516
# do this before any modifications
520
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
521
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
523
# having remove it, it must be either ignored or unknown
524
if tree.is_ignored(f):
528
show_status(new_status, inv[fid].kind, quotefn(f))
531
self._write_inventory(inv)
536
# FIXME: this doesn't need to be a branch method
537
def set_inventory(self, new_inventory_list):
538
from bzrlib.inventory import Inventory, InventoryEntry
539
inv = Inventory(self.get_root_id())
540
for path, file_id, parent, kind in new_inventory_list:
541
name = os.path.basename(path)
544
inv.add(InventoryEntry(file_id, name, kind, parent))
315
545
self._write_inventory(inv)
334
564
return self.working_tree().unknowns()
337
def commit(self, message, timestamp=None, timezone=None,
340
"""Commit working copy as a new revision.
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.
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.
356
:param timestamp: if not None, seconds-since-epoch for a
357
postdated/predated commit.
360
## TODO: Show branch names
362
# TODO: Don't commit if there are no changes, unless forced?
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
372
work_inv = self.read_working_inventory()
374
basis = self.basis_tree()
375
basis_inv = basis.inventory
377
for path, entry in work_inv.iter_entries():
378
## TODO: Cope with files that have gone missing.
380
## TODO: Check that the file kind has not changed from the previous
381
## revision of this file (if any).
386
file_id = entry.file_id
387
mutter('commit prep file %s, id %r ' % (p, file_id))
389
if not os.path.exists(p):
390
mutter(" file is missing, removing from inventory")
392
show_status('D', entry.kind, quotefn(path))
393
missing_ids.append(file_id)
396
# TODO: Handle files that have been deleted
398
# TODO: Maybe a special case for empty files? Seems a
399
# waste to store them many times.
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))
409
if entry.kind == 'directory':
411
bailout("%s is entered as directory but not a directory" % quotefn(p))
412
elif entry.kind == 'file':
414
bailout("%s is entered as file but is not a file" % quotefn(p))
416
content = file(p, 'rb').read()
418
entry.text_sha1 = sha_string(content)
419
entry.text_size = len(content)
421
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
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}' %
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)
437
elif (old_ie.name == entry.name
438
and old_ie.parent_id == entry.parent_id):
443
show_status(state, entry.kind, quotefn(path))
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
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]
456
inv_id = rev_id = _gen_revision_id(time.time())
458
inv_tmp = tempfile.TemporaryFile()
459
inv.write_xml(inv_tmp)
461
self.inventory_store.add(inv_tmp, inv_id)
462
mutter('new inventory_id is {%s}' % inv_id)
464
self._write_inventory(work_inv)
466
if timestamp == None:
467
timestamp = time.time()
469
if committer == None:
470
committer = username()
473
timezone = local_time_offset()
475
mutter("building commit log message")
476
rev = Revision(timestamp=timestamp,
479
precursor = self.last_patch(),
484
rev_tmp = tempfile.TemporaryFile()
485
rev.write_xml(rev_tmp)
487
self.revision_store.add(rev_tmp, rev_id)
488
mutter("new revision_id is {%s}" % rev_id)
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
494
## TODO: Read back the just-generated changeset, and make sure it
495
## applies and recreates the right state.
497
## TODO: Also calculate and store the inventory SHA1
498
mutter("committing patch r%d" % (self.revno() + 1))
500
mutter("append to revision-history")
501
self.controlfile('revision-history', 'at').write(rev_id + '\n')
567
def append_revision(self, *revision_ids):
568
from bzrlib.atomicfile import AtomicFile
570
for revision_id in revision_ids:
571
mutter("add {%s} to revision-history" % revision_id)
573
rev_history = self.revision_history()
574
rev_history.extend(revision_ids)
576
f = AtomicFile(self.controlfilename('revision-history'))
578
for rev_id in rev_history:
506
585
def get_revision(self, revision_id):
507
586
"""Return the Revision object for a named revision"""
508
r = Revision.read_xml(self.revision_store[revision_id])
587
from bzrlib.revision import Revision
588
from bzrlib.xml import unpack_xml
592
if not revision_id or not isinstance(revision_id, basestring):
593
raise ValueError('invalid revision-id: %r' % revision_id)
594
r = unpack_xml(Revision, self.revision_store[revision_id])
509
598
assert r.revision_id == revision_id
602
def get_revision_sha1(self, revision_id):
603
"""Hash the stored value of a revision, and return it."""
604
# In the future, revision entries will be signed. At that
605
# point, it is probably best *not* to include the signature
606
# in the revision hash. Because that lets you re-sign
607
# the revision, (add signatures/remove signatures) and still
608
# have all hash pointers stay consistent.
609
# But for now, just hash the contents.
610
return sha_file(self.revision_store[revision_id])
513
613
def get_inventory(self, inventory_id):
514
614
"""Get Inventory object by hash.
516
:todo: Perhaps for this and similar methods, take a revision
616
TODO: Perhaps for this and similar methods, take a revision
517
617
parameter which can be either an integer revno or a
519
i = Inventory.read_xml(self.inventory_store[inventory_id])
619
from bzrlib.inventory import Inventory
620
from bzrlib.xml import unpack_xml
622
return unpack_xml(Inventory, self.inventory_store[inventory_id])
625
def get_inventory_sha1(self, inventory_id):
626
"""Return the sha1 hash of the inventory entry
628
return sha_file(self.inventory_store[inventory_id])
523
631
def get_revision_inventory(self, revision_id):
524
632
"""Return inventory of a past revision."""
633
# bzr 0.0.6 imposes the constraint that the inventory_id
634
# must be the same as its revision, so this is trivial.
525
635
if revision_id == None:
636
from bzrlib.inventory import Inventory
637
return Inventory(self.get_root_id())
528
return self.get_inventory(self.get_revision(revision_id).inventory_id)
639
return self.get_inventory(revision_id)
531
642
def revision_history(self):
534
645
>>> ScratchBranch().revision_history()
537
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
650
return [l.rstrip('\r\n') for l in
651
self.controlfile('revision-history', 'r').readlines()]
656
def common_ancestor(self, other, self_revno=None, other_revno=None):
659
>>> sb = ScratchBranch(files=['foo', 'foo~'])
660
>>> sb.common_ancestor(sb) == (None, None)
662
>>> commit.commit(sb, "Committing first revision", verbose=False)
663
>>> sb.common_ancestor(sb)[0]
665
>>> clone = sb.clone()
666
>>> commit.commit(sb, "Committing second revision", verbose=False)
667
>>> sb.common_ancestor(sb)[0]
669
>>> sb.common_ancestor(clone)[0]
671
>>> commit.commit(clone, "Committing divergent second revision",
673
>>> sb.common_ancestor(clone)[0]
675
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
677
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
679
>>> clone2 = sb.clone()
680
>>> sb.common_ancestor(clone2)[0]
682
>>> sb.common_ancestor(clone2, self_revno=1)[0]
684
>>> sb.common_ancestor(clone2, other_revno=1)[0]
687
my_history = self.revision_history()
688
other_history = other.revision_history()
689
if self_revno is None:
690
self_revno = len(my_history)
691
if other_revno is None:
692
other_revno = len(other_history)
693
indices = range(min((self_revno, other_revno)))
696
if my_history[r] == other_history[r]:
697
return r+1, my_history[r]
700
def enum_history(self, direction):
701
"""Return (revno, revision_id) for history of branch.
704
'forward' is from earliest to latest
705
'reverse' is from latest to earliest
707
rh = self.revision_history()
708
if direction == 'forward':
713
elif direction == 'reverse':
719
raise ValueError('invalid history direction', direction)
543
725
That is equivalent to the number of revisions committed to
546
>>> b = ScratchBranch()
549
>>> b.commit('no foo')
553
728
return len(self.revision_history())
556
731
def last_patch(self):
557
732
"""Return last patch hash, or None if no history.
559
>>> ScratchBranch().last_patch() == None
562
734
ph = self.revision_history()
567
def lookup_revision(self, revno):
568
"""Return revision hash for revision number."""
573
# list is 0-based; revisions are 1-based
574
return self.revision_history()[revno-1]
576
bailout("no such revision %s" % revno)
741
def missing_revisions(self, other, stop_revision=None):
743
If self and other have not diverged, return a list of the revisions
744
present in other, but missing from self.
746
>>> from bzrlib.commit import commit
747
>>> bzrlib.trace.silent = True
748
>>> br1 = ScratchBranch()
749
>>> br2 = ScratchBranch()
750
>>> br1.missing_revisions(br2)
752
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
753
>>> br1.missing_revisions(br2)
755
>>> br2.missing_revisions(br1)
757
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
758
>>> br1.missing_revisions(br2)
760
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
761
>>> br1.missing_revisions(br2)
763
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
764
>>> br1.missing_revisions(br2)
765
Traceback (most recent call last):
766
DivergedBranches: These branches have diverged.
768
self_history = self.revision_history()
769
self_len = len(self_history)
770
other_history = other.revision_history()
771
other_len = len(other_history)
772
common_index = min(self_len, other_len) -1
773
if common_index >= 0 and \
774
self_history[common_index] != other_history[common_index]:
775
raise DivergedBranches(self, other)
777
if stop_revision is None:
778
stop_revision = other_len
779
elif stop_revision > other_len:
780
raise NoSuchRevision(self, stop_revision)
782
return other_history[self_len:stop_revision]
785
def update_revisions(self, other, stop_revision=None):
786
"""Pull in all new revisions from other branch.
788
>>> from bzrlib.commit import commit
789
>>> bzrlib.trace.silent = True
790
>>> br1 = ScratchBranch(files=['foo', 'bar'])
793
>>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
794
>>> br2 = ScratchBranch()
795
>>> br2.update_revisions(br1)
799
>>> br2.revision_history()
801
>>> br2.update_revisions(br1)
805
>>> br1.text_store.total_size() == br2.text_store.total_size()
808
from bzrlib.progress import ProgressBar
812
pb.update('comparing histories')
813
revision_ids = self.missing_revisions(other, stop_revision)
815
if hasattr(other.revision_store, "prefetch"):
816
other.revision_store.prefetch(revision_ids)
817
if hasattr(other.inventory_store, "prefetch"):
818
inventory_ids = [other.get_revision(r).inventory_id
819
for r in revision_ids]
820
other.inventory_store.prefetch(inventory_ids)
825
for rev_id in revision_ids:
827
pb.update('fetching revision', i, len(revision_ids))
828
rev = other.get_revision(rev_id)
829
revisions.append(rev)
830
inv = other.get_inventory(str(rev.inventory_id))
831
for key, entry in inv.iter_entries():
832
if entry.text_id is None:
834
if entry.text_id not in self.text_store:
835
needed_texts.add(entry.text_id)
839
count = self.text_store.copy_multi(other.text_store, needed_texts)
840
print "Added %d texts." % count
841
inventory_ids = [ f.inventory_id for f in revisions ]
842
count = self.inventory_store.copy_multi(other.inventory_store,
844
print "Added %d inventories." % count
845
revision_ids = [ f.revision_id for f in revisions]
846
count = self.revision_store.copy_multi(other.revision_store,
848
for revision_id in revision_ids:
849
self.append_revision(revision_id)
850
print "Added %d revisions." % count
853
def commit(self, *args, **kw):
854
from bzrlib.commit import commit
855
commit(self, *args, **kw)
858
def lookup_revision(self, revision):
859
"""Return the revision identifier for a given revision information."""
860
revno, info = self.get_revision_info(revision)
863
def get_revision_info(self, revision):
864
"""Return (revno, revision id) for revision identifier.
866
revision can be an integer, in which case it is assumed to be revno (though
867
this will translate negative values into positive ones)
868
revision can also be a string, in which case it is parsed for something like
869
'date:' or 'revid:' etc.
874
try:# Convert to int if possible
875
revision = int(revision)
878
revs = self.revision_history()
879
if isinstance(revision, int):
882
# Mabye we should do this first, but we don't need it if revision == 0
884
revno = len(revs) + revision + 1
887
elif isinstance(revision, basestring):
888
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
889
if revision.startswith(prefix):
890
revno = func(self, revs, revision)
893
raise BzrError('No namespace registered for string: %r' % revision)
895
if revno is None or revno <= 0 or revno > len(revs):
896
raise BzrError("no such revision %s" % revision)
897
return revno, revs[revno-1]
899
def _namespace_revno(self, revs, revision):
900
"""Lookup a revision by revision number"""
901
assert revision.startswith('revno:')
903
return int(revision[6:])
906
REVISION_NAMESPACES['revno:'] = _namespace_revno
908
def _namespace_revid(self, revs, revision):
909
assert revision.startswith('revid:')
911
return revs.index(revision[6:]) + 1
914
REVISION_NAMESPACES['revid:'] = _namespace_revid
916
def _namespace_last(self, revs, revision):
917
assert revision.startswith('last:')
919
offset = int(revision[5:])
924
raise BzrError('You must supply a positive value for --revision last:XXX')
925
return len(revs) - offset + 1
926
REVISION_NAMESPACES['last:'] = _namespace_last
928
def _namespace_tag(self, revs, revision):
929
assert revision.startswith('tag:')
930
raise BzrError('tag: namespace registered, but not implemented.')
931
REVISION_NAMESPACES['tag:'] = _namespace_tag
933
def _namespace_date(self, revs, revision):
934
assert revision.startswith('date:')
936
# Spec for date revisions:
938
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
939
# it can also start with a '+/-/='. '+' says match the first
940
# entry after the given date. '-' is match the first entry before the date
941
# '=' is match the first entry after, but still on the given date.
943
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
944
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
945
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
946
# May 13th, 2005 at 0:00
948
# So the proper way of saying 'give me all entries for today' is:
949
# -r {date:+today}:{date:-tomorrow}
950
# The default is '=' when not supplied
953
if val[:1] in ('+', '-', '='):
954
match_style = val[:1]
957
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
958
if val.lower() == 'yesterday':
959
dt = today - datetime.timedelta(days=1)
960
elif val.lower() == 'today':
962
elif val.lower() == 'tomorrow':
963
dt = today + datetime.timedelta(days=1)
966
# This should be done outside the function to avoid recompiling it.
967
_date_re = re.compile(
968
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
970
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
972
m = _date_re.match(val)
973
if not m or (not m.group('date') and not m.group('time')):
974
raise BzrError('Invalid revision date %r' % revision)
977
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
979
year, month, day = today.year, today.month, today.day
981
hour = int(m.group('hour'))
982
minute = int(m.group('minute'))
983
if m.group('second'):
984
second = int(m.group('second'))
988
hour, minute, second = 0,0,0
990
dt = datetime.datetime(year=year, month=month, day=day,
991
hour=hour, minute=minute, second=second)
995
if match_style == '-':
997
elif match_style == '=':
998
last = dt + datetime.timedelta(days=1)
1001
for i in range(len(revs)-1, -1, -1):
1002
r = self.get_revision(revs[i])
1003
# TODO: Handle timezone.
1004
dt = datetime.datetime.fromtimestamp(r.timestamp)
1005
if first >= dt and (last is None or dt >= last):
1008
for i in range(len(revs)):
1009
r = self.get_revision(revs[i])
1010
# TODO: Handle timezone.
1011
dt = datetime.datetime.fromtimestamp(r.timestamp)
1012
if first <= dt and (last is None or dt <= last):
1014
REVISION_NAMESPACES['date:'] = _namespace_date
579
1016
def revision_tree(self, revision_id):
580
1017
"""Return Tree for a revision on this branch.
582
1019
`revision_id` may be None for the null revision, in which case
583
1020
an `EmptyTree` is returned."""
1021
from bzrlib.tree import EmptyTree, RevisionTree
1022
# TODO: refactor this to use an existing revision object
1023
# so we don't need to read it in twice.
585
1024
if revision_id == None:
1025
return EmptyTree(self.get_root_id())
588
1027
inv = self.get_revision_inventory(revision_id)
589
1028
return RevisionTree(self.text_store, inv)
598
1038
"""Return `Tree` object for last revision.
600
1040
If there are no revisions yet, return an `EmptyTree`.
602
>>> b = ScratchBranch(files=['foo'])
603
>>> b.basis_tree().has_filename('foo')
605
>>> b.working_tree().has_filename('foo')
608
>>> b.commit('add foo')
609
>>> b.basis_tree().has_filename('foo')
1042
from bzrlib.tree import EmptyTree, RevisionTree
612
1043
r = self.last_patch()
1045
return EmptyTree(self.get_root_id())
616
1047
return RevisionTree(self.text_store, self.get_revision_inventory(r))
620
def write_log(self, show_timezone='original'):
621
"""Write out human-readable log of commits to this branch
623
:param utc: If true, show dates in universal time, not local time."""
624
## TODO: Option to choose either original, utc or local timezone
627
for p in self.revision_history():
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,
637
## opportunistic consistency check, same as check_patch_chaining
638
if rev.precursor != precursor:
639
bailout("mismatched precursor!")
643
print ' (no message)'
645
for l in rev.message.split('\n'):
653
def show_status(branch, show_all=False):
654
"""Display single-line status for non-ignored working files.
656
The list is show sorted in order by file name.
658
>>> b = ScratchBranch(files=['foo', 'foo~'])
664
>>> b.commit("add foo")
667
:todo: Get state for single files.
669
:todo: Perhaps show a slash at the end of directory names.
673
# We have to build everything into a list first so that it can
674
# sorted by name, incorporating all the different sources.
676
# FIXME: Rather than getting things in random order and then sorting,
677
# just step through in order.
679
# Interesting case: the old ID for a file has been removed,
680
# but a new file has been created under that name.
682
old = branch.basis_tree()
683
old_inv = old.inventory
684
new = branch.working_tree()
685
new_inv = new.inventory
687
for fs, fid, oldname, newname, kind in diff_trees(old, new):
689
show_status(fs, kind,
690
oldname + ' => ' + newname)
691
elif fs == 'A' or fs == 'M':
692
show_status(fs, kind, newname)
694
show_status(fs, kind, oldname)
697
show_status(fs, kind, newname)
700
show_status(fs, kind, newname)
702
show_status(fs, kind, newname)
704
bailout("wierd file state %r" % ((fs, fid),))
1051
def rename_one(self, from_rel, to_rel):
1054
This can change the directory or the filename or both.
1058
tree = self.working_tree()
1059
inv = tree.inventory
1060
if not tree.has_filename(from_rel):
1061
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1062
if tree.has_filename(to_rel):
1063
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1065
file_id = inv.path2id(from_rel)
1067
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1069
if inv.path2id(to_rel):
1070
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1072
to_dir, to_tail = os.path.split(to_rel)
1073
to_dir_id = inv.path2id(to_dir)
1074
if to_dir_id == None and to_dir != '':
1075
raise BzrError("can't determine destination directory id for %r" % to_dir)
1077
mutter("rename_one:")
1078
mutter(" file_id {%s}" % file_id)
1079
mutter(" from_rel %r" % from_rel)
1080
mutter(" to_rel %r" % to_rel)
1081
mutter(" to_dir %r" % to_dir)
1082
mutter(" to_dir_id {%s}" % to_dir_id)
1084
inv.rename(file_id, to_dir_id, to_tail)
1086
print "%s => %s" % (from_rel, to_rel)
1088
from_abs = self.abspath(from_rel)
1089
to_abs = self.abspath(to_rel)
1091
os.rename(from_abs, to_abs)
1093
raise BzrError("failed to rename %r to %r: %s"
1094
% (from_abs, to_abs, e[1]),
1095
["rename rolled back"])
1097
self._write_inventory(inv)
1102
def move(self, from_paths, to_name):
1105
to_name must exist as a versioned directory.
1107
If to_name exists and is a directory, the files are moved into
1108
it, keeping their old names. If it is a directory,
1110
Note that to_name is only the last component of the new name;
1111
this doesn't change the directory.
1115
## TODO: Option to move IDs only
1116
assert not isinstance(from_paths, basestring)
1117
tree = self.working_tree()
1118
inv = tree.inventory
1119
to_abs = self.abspath(to_name)
1120
if not isdir(to_abs):
1121
raise BzrError("destination %r is not a directory" % to_abs)
1122
if not tree.has_filename(to_name):
1123
raise BzrError("destination %r not in working directory" % to_abs)
1124
to_dir_id = inv.path2id(to_name)
1125
if to_dir_id == None and to_name != '':
1126
raise BzrError("destination %r is not a versioned directory" % to_name)
1127
to_dir_ie = inv[to_dir_id]
1128
if to_dir_ie.kind not in ('directory', 'root_directory'):
1129
raise BzrError("destination %r is not a directory" % to_abs)
1131
to_idpath = inv.get_idpath(to_dir_id)
1133
for f in from_paths:
1134
if not tree.has_filename(f):
1135
raise BzrError("%r does not exist in working tree" % f)
1136
f_id = inv.path2id(f)
1138
raise BzrError("%r is not versioned" % f)
1139
name_tail = splitpath(f)[-1]
1140
dest_path = appendpath(to_name, name_tail)
1141
if tree.has_filename(dest_path):
1142
raise BzrError("destination %r already exists" % dest_path)
1143
if f_id in to_idpath:
1144
raise BzrError("can't move %r to a subdirectory of itself" % f)
1146
# OK, so there's a race here, it's possible that someone will
1147
# create a file in this interval and then the rename might be
1148
# left half-done. But we should have caught most problems.
1150
for f in from_paths:
1151
name_tail = splitpath(f)[-1]
1152
dest_path = appendpath(to_name, name_tail)
1153
print "%s => %s" % (f, dest_path)
1154
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1156
os.rename(self.abspath(f), self.abspath(dest_path))
1158
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1159
["rename rolled back"])
1161
self._write_inventory(inv)
1166
def revert(self, filenames, old_tree=None, backups=True):
1167
"""Restore selected files to the versions from a previous tree.
1170
If true (default) backups are made of files before
1173
from bzrlib.errors import NotVersionedError, BzrError
1174
from bzrlib.atomicfile import AtomicFile
1175
from bzrlib.osutils import backup_file
1177
inv = self.read_working_inventory()
1178
if old_tree is None:
1179
old_tree = self.basis_tree()
1180
old_inv = old_tree.inventory
1183
for fn in filenames:
1184
file_id = inv.path2id(fn)
1186
raise NotVersionedError("not a versioned file", fn)
1187
if not old_inv.has_id(file_id):
1188
raise BzrError("file not present in old tree", fn, file_id)
1189
nids.append((fn, file_id))
1191
# TODO: Rename back if it was previously at a different location
1193
# TODO: If given a directory, restore the entire contents from
1194
# the previous version.
1196
# TODO: Make a backup to a temporary file.
1198
# TODO: If the file previously didn't exist, delete it?
1199
for fn, file_id in nids:
1202
f = AtomicFile(fn, 'wb')
1204
f.write(old_tree.get_file(file_id).read())
1210
def pending_merges(self):
1211
"""Return a list of pending merges.
1213
These are revisions that have been merged into the working
1214
directory but not yet committed.
1216
cfn = self.controlfilename('pending-merges')
1217
if not os.path.exists(cfn):
1220
for l in self.controlfile('pending-merges', 'r').readlines():
1221
p.append(l.rstrip('\n'))
1225
def add_pending_merge(self, revision_id):
1226
from bzrlib.revision import validate_revision_id
1228
validate_revision_id(revision_id)
1230
p = self.pending_merges()
1231
if revision_id in p:
1233
p.append(revision_id)
1234
self.set_pending_merges(p)
1237
def set_pending_merges(self, rev_list):
1238
from bzrlib.atomicfile import AtomicFile
1241
f = AtomicFile(self.controlfilename('pending-merges'))
708
1253
class ScratchBranch(Branch):