« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 10
- compare with another revision
- download diff
- download tarball
- view history from revision 10
- Committer: mbp at sourcefrog
- Date: 2005-03-09 06:49:00 UTC
- Revision ID: mbp@sourcefrog.net-20050309064900-74935ffb7350b24b
import more files from baz
- files added:
- bzrlib/tests.py
- files removed:
- .bzrignore
- 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 renamed:
- bzrlib/commands.py => bzr.py
- files modified:
- README
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
1
#! /usr/bin/env python
2
# -*- coding: UTF-8 -*-
2
3
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
17
18
18
import sys
19
import os
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
20
24
21
25
import bzrlib
22
from bzrlib.trace import mutter, note
23
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
splitpath, \
25
sha_file, appendpath, file_kind
26
27
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
28
import bzrlib.errors
29
from bzrlib.textui import show_status
30
from bzrlib.revision import Revision
31
from bzrlib.xml import unpack_xml
32
from bzrlib.delta import compare_trees
33
from bzrlib.tree import EmptyTree, RevisionTree
34
import bzrlib.ui
35
36
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
37
38
38
39
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
40
## TODO: Maybe include checks for common corruption of newlines, etc?
40
41
41
42
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.")
43
142
44
143
45
144
46
######################################################################
145
47
# branch objects
146
48
147
class Branch(object):
49
class Branch:
148
50
"""Branch holding a history of revisions.
149
51
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.
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.
162
64
"""
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):
65
def __init__(self, base, init=False):
174
66
"""Create new branch object at a particular location.
175
67
176
base -- Base directory for the branch.
177
178
init -- If True, create new control files in a previously
68
:param base: Base directory for the branch.
69
70
:param init: If True, create new control files in a previously
179
71
unversioned directory. If False, the branch must already
180
72
be versioned.
181
73
182
find_root -- If true and init is false, find the root of the
183
existing branch containing base.
184
185
74
In the test suite, creation of new trees is tested using the
186
75
`ScratchBranch` class.
187
76
"""
188
from bzrlib.store import ImmutableStore
77
self.base = os.path.realpath(base)
189
78
if init:
190
self.base = os.path.realpath(base)
191
79
self._make_control()
192
elif find_root:
193
self.base = find_branch_root(base)
194
80
else:
195
self.base = os.path.realpath(base)
196
81
if not isdir(self.controlfilename('.')):
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()
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()
202
86
203
87
self.text_store = ImmutableStore(self.controlfilename('text-store'))
204
88
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
212
96
__repr__ = __str__
213
97
214
98
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"""
99
def _rel(self, name):
100
"""Return filename relative to branch top"""
263
101
return os.path.join(self.base, name)
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)
102
270
103
271
104
def controlfilename(self, file_or_path):
272
105
"""Return location relative to branch."""
273
if isinstance(file_or_path, basestring):
106
if isinstance(file_or_path, types.StringTypes):
274
107
file_or_path = [file_or_path]
275
108
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
276
109
277
110
278
111
def controlfile(self, file_or_path, mode='r'):
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)
112
"""Open a control file for this branch"""
113
return file(self.controlfilename(file_or_path), mode)
114
302
115
303
116
def _make_control(self):
304
from bzrlib.inventory import Inventory
305
from bzrlib.xml import pack_xml
306
307
117
os.mkdir(self.controlfilename([]))
308
118
self.controlfile('README', 'w').write(
309
119
"This is a Bazaar-NG control directory.\n"
310
"Do not change any files in this directory.\n")
120
"Do not change any files in this directory.")
311
121
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
312
122
for d in ('text-store', 'inventory-store', 'revision-store'):
313
123
os.mkdir(self.controlfilename(d))
314
124
for f in ('revision-history', 'merged-patches',
315
'pending-merged-patches', 'branch-name',
316
'branch-lock',
317
'pending-merges'):
125
'pending-merged-patches', 'branch-name'):
318
126
self.controlfile(f, 'w').write('')
319
127
mutter('created control directory in ' + self.base)
128
Inventory().write_xml(self.controlfile('inventory','w'))
320
129
321
# if we want per-tree root ids then this is the place to set
322
# them; they're not needed for now and so ommitted for
323
# simplicity.
324
pack_xml(Inventory(), self.controlfile('inventory','w'))
325
130
326
131
def _check_format(self):
327
132
"""Check this branch format is supported.
330
135
331
136
In the future, we might need different in-memory Branch
332
137
classes to support downlevel branches. But not yet.
333
"""
334
# This ignores newlines so that we can open branches created
335
# on Windows from Linux and so on. I think it might be better
336
# to always make all internal files in unix format.
337
fmt = self.controlfile('branch-format', 'r').read()
338
fmt.replace('\r\n', '')
138
"""
139
# read in binary mode to detect newline wierdness.
140
fmt = self.controlfile('branch-format', 'rb').read()
339
141
if fmt != BZR_BRANCH_FORMAT:
340
raise BzrError('sorry, branch format %r not supported' % fmt,
341
['use a different bzr version',
342
'or remove the .bzr directory and "bzr init" again'])
343
344
def get_root_id(self):
345
"""Return the id of this branches root"""
346
inv = self.read_working_inventory()
347
return inv.root.file_id
348
349
def set_root_id(self, file_id):
350
inv = self.read_working_inventory()
351
orig_root_id = inv.root.file_id
352
del inv._byid[inv.root.file_id]
353
inv.root.file_id = file_id
354
inv._byid[inv.root.file_id] = inv.root
355
for fid in inv:
356
entry = inv[fid]
357
if entry.parent_id in (None, orig_root_id):
358
entry.parent_id = inv.root.file_id
359
self._write_inventory(inv)
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
360
146
361
147
def read_working_inventory(self):
362
148
"""Read the working inventory."""
363
from bzrlib.inventory import Inventory
364
from bzrlib.xml import unpack_xml
365
from time import time
366
before = time()
367
self.lock_read()
368
try:
369
# ElementTree does its own conversion from UTF-8, so open in
370
# binary.
371
inv = unpack_xml(Inventory,
372
self.controlfile('inventory', 'rb'))
373
mutter("loaded inventory of %d items in %f"
374
% (len(inv), time() - before))
375
return inv
376
finally:
377
self.unlock()
378
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
379
155
380
156
def _write_inventory(self, inv):
381
157
"""Update the working inventory.
383
159
That is to say, the inventory describing changes underway, that
384
160
will be committed to the next revision.
385
161
"""
386
from bzrlib.atomicfile import AtomicFile
387
from bzrlib.xml import pack_xml
388
389
self.lock_write()
390
try:
391
f = AtomicFile(self.controlfilename('inventory'), 'wb')
392
try:
393
pack_xml(inv, f)
394
f.commit()
395
finally:
396
f.close()
397
finally:
398
self.unlock()
399
400
mutter('wrote working inventory')
401
162
inv.write_xml(self.controlfile('inventory', 'w'))
163
mutter('wrote inventory to %s' % quotefn(self.controlfilename('inventory')))
164
402
165
403
166
inventory = property(read_working_inventory, _write_inventory, None,
404
167
"""Inventory for the working copy.""")
405
168
406
169
407
def add(self, files, ids=None):
170
def add(self, files, verbose=False):
408
171
"""Make files versioned.
409
172
410
Note that the command line normally calls smart_add instead,
411
which can automatically recurse.
412
413
173
This puts the files in the Added state, so that they will be
414
174
recorded by the next commit.
415
175
416
files
417
List of paths to add, relative to the base of the tree.
418
419
ids
420
If set, use these instead of automatically generated ids.
421
Must be the same length as the list of files, but may
422
contain None for ids that are to be autogenerated.
423
424
TODO: Perhaps have an option to add the ids even if the files do
425
not (yet) exist.
426
427
TODO: Perhaps yield the ids and paths as they're added.
176
:todo: Perhaps have an option to add the ids even if the files do
177
not (yet) exist.
178
179
:todo: Perhaps return the ids of the files? But then again it
180
is easy to retrieve them if they're needed.
181
182
:todo: Option to specify file id.
183
184
:todo: Adding a directory should optionally recurse down and
185
add all non-ignored children. Perhaps do that in a
186
higher-level method.
187
188
>>> b = ScratchBranch(files=['foo'])
189
>>> 'foo' in b.unknowns()
190
True
191
>>> b.show_status()
192
? foo
193
>>> b.add('foo')
194
>>> 'foo' in b.unknowns()
195
False
196
>>> bool(b.inventory.path2id('foo'))
197
True
198
>>> b.show_status()
199
A foo
200
201
>>> b.add('foo')
202
Traceback (most recent call last):
203
...
204
BzrError: ('foo is already versioned', [])
205
206
>>> b.add(['nothere'])
207
Traceback (most recent call last):
208
BzrError: ('cannot add: not a regular file or directory: nothere', [])
428
209
"""
210
429
211
# TODO: Re-adding a file that is removed in the working copy
430
212
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
213
if isinstance(files, types.StringTypes):
433
214
files = [files]
434
if ids is not None:
435
ids = [ids]
436
437
if ids is None:
438
ids = [None] * len(files)
439
else:
440
assert(len(ids) == len(files))
441
442
self.lock_write()
443
try:
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
448
449
fp = splitpath(f)
450
451
if len(fp) == 0:
452
raise BzrError("cannot add top-level %r" % f)
453
454
fullpath = os.path.normpath(self.abspath(f))
455
456
try:
457
kind = file_kind(fullpath)
458
except OSError:
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
465
if file_id is None:
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
468
469
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
470
471
self._write_inventory(inv)
472
finally:
473
self.unlock()
474
475
476
def print_file(self, file, revno):
477
"""Print `file` to stdout."""
478
self.lock_read()
479
try:
480
tree = self.revision_tree(self.lookup_revision(revno))
481
# use inventory as it was in that revision
482
file_id = tree.inventory.path2id(file)
483
if not file_id:
484
raise BzrError("%r is not present in revision %s" % (file, revno))
485
tree.print_file(file_id)
486
finally:
487
self.unlock()
215
216
inv = self.read_working_inventory()
217
for f in files:
218
if is_control_file(f):
219
bailout("cannot add control file %s" % quotefn(f))
220
221
fp = splitpath(f)
222
223
if len(fp) == 0:
224
bailout("cannot add top-level %r" % f)
225
226
fullpath = os.path.normpath(self._rel(f))
227
228
if isfile(fullpath):
229
kind = 'file'
230
elif isdir(fullpath):
231
kind = 'directory'
232
else:
233
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
234
235
if len(fp) > 1:
236
parent_name = joinpath(fp[:-1])
237
mutter("lookup parent %r" % parent_name)
238
parent_id = inv.path2id(parent_name)
239
if parent_id == None:
240
bailout("cannot add: parent %r is not versioned"
241
% joinpath(fp[:-1]))
242
else:
243
parent_id = None
244
245
file_id = _gen_file_id(fp[-1])
246
inv.add(InventoryEntry(file_id, fp[-1], kind=kind, parent_id=parent_id))
247
if verbose:
248
show_status('A', kind, quotefn(f))
249
250
mutter("add file %s file_id:{%s} kind=%r parent_id={%s}"
251
% (f, file_id, kind, parent_id))
252
self._write_inventory(inv)
253
488
254
489
255
490
256
def remove(self, files, verbose=False):
492
258
493
259
This does not remove their text. This does not run on
494
260
495
TODO: Refuse to remove modified files unless --force is given?
496
497
TODO: Do something useful with directories.
498
499
TODO: Should this remove the text or not? Tough call; not
261
:todo: Refuse to remove modified files unless --force is given?
262
263
>>> b = ScratchBranch(files=['foo'])
264
>>> b.add('foo')
265
>>> b.inventory.has_filename('foo')
266
True
267
>>> b.remove('foo')
268
>>> b.working_tree().has_filename('foo')
269
True
270
>>> b.inventory.has_filename('foo')
271
False
272
273
>>> b = ScratchBranch(files=['foo'])
274
>>> b.add('foo')
275
>>> b.commit('one')
276
>>> b.remove('foo')
277
>>> b.commit('two')
278
>>> b.inventory.has_filename('foo')
279
False
280
>>> b.basis_tree().has_filename('foo')
281
False
282
>>> b.working_tree().has_filename('foo')
283
True
284
285
:todo: Do something useful with directories.
286
287
:todo: Should this remove the text or not? Tough call; not
500
288
removing may be useful and the user can just use use rm, and
501
289
is the opposite of add. Removing it is consistent with most
502
290
other tools. Maybe an option.
503
291
"""
504
292
## TODO: Normalize names
505
293
## TODO: Remove nested loops; better scalability
506
if isinstance(files, basestring):
294
295
if isinstance(files, types.StringTypes):
507
296
files = [files]
508
509
self.lock_write()
510
511
try:
512
tree = self.working_tree()
513
inv = tree.inventory
514
515
# do this before any modifications
516
for f in files:
517
fid = inv.path2id(f)
518
if not fid:
519
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
520
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
521
if verbose:
522
# having remove it, it must be either ignored or unknown
523
if tree.is_ignored(f):
524
new_status = 'I'
525
else:
526
new_status = '?'
527
show_status(new_status, inv[fid].kind, quotefn(f))
528
del inv[fid]
529
530
self._write_inventory(inv)
531
finally:
532
self.unlock()
533
534
535
# FIXME: this doesn't need to be a branch method
536
def set_inventory(self, new_inventory_list):
537
from bzrlib.inventory import Inventory, InventoryEntry
538
inv = Inventory(self.get_root_id())
539
for path, file_id, parent, kind in new_inventory_list:
540
name = os.path.basename(path)
541
if name == "":
542
continue
543
inv.add(InventoryEntry(file_id, name, kind, parent))
297
298
inv = self.read_working_inventory()
299
300
# do this before any modifications
301
for f in files:
302
fid = inv.path2id(f)
303
if not fid:
304
bailout("cannot remove unversioned file %s" % quotefn(f))
305
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
306
if verbose:
307
show_status('D', inv[fid].kind, quotefn(f))
308
del inv[fid]
309
544
310
self._write_inventory(inv)
545
311
546
312
563
329
return self.working_tree().unknowns()
564
330
565
331
566
def append_revision(self, *revision_ids):
567
from bzrlib.atomicfile import AtomicFile
568
569
for revision_id in revision_ids:
570
mutter("add {%s} to revision-history" % revision_id)
571
572
rev_history = self.revision_history()
573
rev_history.extend(revision_ids)
574
575
f = AtomicFile(self.controlfilename('revision-history'))
576
try:
577
for rev_id in rev_history:
578
print >>f, rev_id
579
f.commit()
580
finally:
581
f.close()
582
583
584
def get_revision_xml(self, revision_id):
585
"""Return XML file object for revision object."""
586
if not revision_id or not isinstance(revision_id, basestring):
587
raise InvalidRevisionId(revision_id)
588
589
self.lock_read()
590
try:
591
try:
592
return self.revision_store[revision_id]
593
except IndexError:
594
raise bzrlib.errors.NoSuchRevision(self, revision_id)
595
finally:
596
self.unlock()
332
def commit(self, message, timestamp=None, timezone=None,
333
committer=None,
334
verbose=False):
335
"""Commit working copy as a new revision.
336
337
The basic approach is to add all the file texts into the
338
store, then the inventory, then make a new revision pointing
339
to that inventory and store that.
340
341
This is not quite safe if the working copy changes during the
342
commit; for the moment that is simply not allowed. A better
343
approach is to make a temporary copy of the files before
344
computing their hashes, and then add those hashes in turn to
345
the inventory. This should mean at least that there are no
346
broken hash pointers. There is no way we can get a snapshot
347
of the whole directory at an instant. This would also have to
348
be robust against files disappearing, moving, etc. So the
349
whole thing is a bit hard.
350
351
:param timestamp: if not None, seconds-since-epoch for a
352
postdated/predated commit.
353
"""
354
355
## TODO: Show branch names
356
357
# TODO: Don't commit if there are no changes, unless forced?
358
359
# First walk over the working inventory; and both update that
360
# and also build a new revision inventory. The revision
361
# inventory needs to hold the text-id, sha1 and size of the
362
# actual file versions committed in the revision. (These are
363
# not present in the working inventory.) We also need to
364
# detect missing/deleted files, and remove them from the
365
# working inventory.
366
367
work_inv = self.read_working_inventory()
368
inv = Inventory()
369
basis = self.basis_tree()
370
basis_inv = basis.inventory
371
missing_ids = []
372
for path, entry in work_inv.iter_entries():
373
## TODO: Cope with files that have gone missing.
374
375
## TODO: Check that the file kind has not changed from the previous
376
## revision of this file (if any).
377
378
entry = entry.copy()
379
380
p = self._rel(path)
381
file_id = entry.file_id
382
mutter('commit prep file %s, id %r ' % (p, file_id))
383
384
if not os.path.exists(p):
385
mutter(" file is missing, removing from inventory")
386
if verbose:
387
show_status('D', entry.kind, quotefn(path))
388
missing_ids.append(file_id)
389
continue
390
391
# TODO: Handle files that have been deleted
392
393
# TODO: Maybe a special case for empty files? Seems a
394
# waste to store them many times.
395
396
inv.add(entry)
397
398
if basis_inv.has_id(file_id):
399
old_kind = basis_inv[file_id].kind
400
if old_kind != entry.kind:
401
bailout("entry %r changed kind from %r to %r"
402
% (file_id, old_kind, entry.kind))
403
404
if entry.kind == 'directory':
405
if not isdir(p):
406
bailout("%s is entered as directory but not a directory" % quotefn(p))
407
elif entry.kind == 'file':
408
if not isfile(p):
409
bailout("%s is entered as file but is not a file" % quotefn(p))
410
411
content = file(p, 'rb').read()
412
413
entry.text_sha1 = sha_string(content)
414
entry.text_size = len(content)
415
416
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
417
if (old_ie
418
and (old_ie.text_size == entry.text_size)
419
and (old_ie.text_sha1 == entry.text_sha1)):
420
## assert content == basis.get_file(file_id).read()
421
entry.text_id = basis_inv[file_id].text_id
422
mutter(' unchanged from previous text_id {%s}' %
423
entry.text_id)
424
425
else:
426
entry.text_id = _gen_file_id(entry.name)
427
self.text_store.add(content, entry.text_id)
428
mutter(' stored with text_id {%s}' % entry.text_id)
429
if verbose:
430
if not old_ie:
431
state = 'A'
432
elif (old_ie.name == entry.name
433
and old_ie.parent_id == entry.parent_id):
434
state = 'R'
435
else:
436
state = 'M'
437
438
show_status(state, entry.kind, quotefn(path))
439
440
for file_id in missing_ids:
441
# have to do this later so we don't mess up the iterator.
442
# since parents may be removed before their children we
443
# have to test.
444
445
# FIXME: There's probably a better way to do this; perhaps
446
# the workingtree should know how to filter itself.
447
if work_inv.has_id(file_id):
448
del work_inv[file_id]
449
450
451
inv_id = rev_id = _gen_revision_id(time.time())
452
453
inv_tmp = tempfile.TemporaryFile()
454
inv.write_xml(inv_tmp)
455
inv_tmp.seek(0)
456
self.inventory_store.add(inv_tmp, inv_id)
457
mutter('new inventory_id is {%s}' % inv_id)
458
459
self._write_inventory(work_inv)
460
461
if timestamp == None:
462
timestamp = time.time()
463
464
if committer == None:
465
committer = username()
466
467
if timezone == None:
468
timezone = local_time_offset()
469
470
mutter("building commit log message")
471
rev = Revision(timestamp=timestamp,
472
timezone=timezone,
473
committer=committer,
474
precursor = self.last_patch(),
475
message = message,
476
inventory_id=inv_id,
477
revision_id=rev_id)
478
479
rev_tmp = tempfile.TemporaryFile()
480
rev.write_xml(rev_tmp)
481
rev_tmp.seek(0)
482
self.revision_store.add(rev_tmp, rev_id)
483
mutter("new revision_id is {%s}" % rev_id)
484
485
## XXX: Everything up to here can simply be orphaned if we abort
486
## the commit; it will leave junk files behind but that doesn't
487
## matter.
488
489
## TODO: Read back the just-generated changeset, and make sure it
490
## applies and recreates the right state.
491
492
## TODO: Also calculate and store the inventory SHA1
493
mutter("committing patch r%d" % (self.revno() + 1))
494
495
mutter("append to revision-history")
496
self.controlfile('revision-history', 'at').write(rev_id + '\n')
497
498
mutter("done!")
597
499
598
500
599
501
def get_revision(self, revision_id):
600
502
"""Return the Revision object for a named revision"""
601
xml_file = self.get_revision_xml(revision_id)
602
603
try:
604
r = unpack_xml(Revision, xml_file)
605
except SyntaxError, e:
606
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
607
[revision_id,
608
str(e)])
609
503
r = Revision.read_xml(self.revision_store[revision_id])
610
504
assert r.revision_id == revision_id
611
505
return r
612
506
613
507
614
def get_revision_delta(self, revno):
615
"""Return the delta for one revision.
616
617
The delta is relative to its mainline predecessor, or the
618
empty tree for revision 1.
619
"""
620
assert isinstance(revno, int)
621
rh = self.revision_history()
622
if not (1 <= revno <= len(rh)):
623
raise InvalidRevisionNumber(revno)
624
625
# revno is 1-based; list is 0-based
626
627
new_tree = self.revision_tree(rh[revno-1])
628
if revno == 1:
629
old_tree = EmptyTree()
630
else:
631
old_tree = self.revision_tree(rh[revno-2])
632
633
return compare_trees(old_tree, new_tree)
634
635
636
637
def get_revision_sha1(self, revision_id):
638
"""Hash the stored value of a revision, and return it."""
639
# In the future, revision entries will be signed. At that
640
# point, it is probably best *not* to include the signature
641
# in the revision hash. Because that lets you re-sign
642
# the revision, (add signatures/remove signatures) and still
643
# have all hash pointers stay consistent.
644
# But for now, just hash the contents.
645
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
646
647
648
508
def get_inventory(self, inventory_id):
649
509
"""Get Inventory object by hash.
650
510
651
TODO: Perhaps for this and similar methods, take a revision
511
:todo: Perhaps for this and similar methods, take a revision
652
512
parameter which can be either an integer revno or a
653
513
string hash."""
654
from bzrlib.inventory import Inventory
655
from bzrlib.xml import unpack_xml
656
657
return unpack_xml(Inventory, self.get_inventory_xml(inventory_id))
658
659
660
def get_inventory_xml(self, inventory_id):
661
"""Get inventory XML as a file object."""
662
return self.inventory_store[inventory_id]
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))
514
i = Inventory.read_xml(self.inventory_store[inventory_id])
515
return i
669
516
670
517
671
518
def get_revision_inventory(self, revision_id):
672
519
"""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.
675
520
if revision_id == None:
676
from bzrlib.inventory import Inventory
677
return Inventory(self.get_root_id())
521
return Inventory()
678
522
else:
679
return self.get_inventory(revision_id)
523
return self.get_inventory(self.get_revision(revision_id).inventory_id)
680
524
681
525
682
526
def revision_history(self):
685
529
>>> ScratchBranch().revision_history()
686
530
[]
687
531
"""
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
532
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
739
533
740
534
741
535
def revno(self):
743
537
744
538
That is equivalent to the number of revisions committed to
745
539
this branch.
540
541
>>> b = ScratchBranch()
542
>>> b.revno()
543
0
544
>>> b.commit('no foo')
545
>>> b.revno()
546
1
746
547
"""
747
548
return len(self.revision_history())
748
549
749
550
750
551
def last_patch(self):
751
552
"""Return last patch hash, or None if no history.
553
554
>>> ScratchBranch().last_patch() == None
555
True
752
556
"""
753
557
ph = self.revision_history()
754
558
if ph:
755
559
return ph[-1]
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."""
560
561
562
def lookup_revision(self, revno):
563
"""Return revision hash for revision number."""
907
564
if revno == 0:
908
565
return None
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
566
567
try:
568
# list is 0-based; revisions are 1-based
569
return self.revision_history()[revno-1]
570
except IndexError:
571
bailout("no such revision %s" % revno)
572
1080
573
1081
574
def revision_tree(self, revision_id):
1082
575
"""Return Tree for a revision on this branch.
1083
576
1084
577
`revision_id` may be None for the null revision, in which case
1085
578
an `EmptyTree` is returned."""
1086
# TODO: refactor this to use an existing revision object
1087
# so we don't need to read it in twice.
579
1088
580
if revision_id == None:
1089
581
return EmptyTree()
1090
582
else:
1094
586
1095
587
def working_tree(self):
1096
588
"""Return a `Tree` for the working copy."""
1097
from workingtree import WorkingTree
1098
589
return WorkingTree(self.base, self.read_working_inventory())
1099
590
1100
591
1102
593
"""Return `Tree` object for last revision.
1103
594
1104
595
If there are no revisions yet, return an `EmptyTree`.
596
597
>>> b = ScratchBranch(files=['foo'])
598
>>> b.basis_tree().has_filename('foo')
599
False
600
>>> b.working_tree().has_filename('foo')
601
True
602
>>> b.add('foo')
603
>>> b.commit('add foo')
604
>>> b.basis_tree().has_filename('foo')
605
True
1105
606
"""
1106
607
r = self.last_patch()
1107
608
if r == None:
1111
612
1112
613
1113
614
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
615
def write_log(self, utc=False):
616
"""Write out human-readable log of commits to this branch
617
618
:param utc: If true, show dates in universal time, not local time."""
619
## TODO: Option to choose either original, utc or local timezone
620
revno = 1
621
precursor = None
622
for p in self.revision_history():
623
print '-' * 40
624
print 'revno:', revno
625
## TODO: Show hash if --id is given.
626
##print 'revision-hash:', p
627
rev = self.get_revision(p)
628
print 'committer:', rev.committer
629
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0))
630
631
## opportunistic consistency check, same as check_patch_chaining
632
if rev.precursor != precursor:
633
bailout("mismatched precursor!")
634
635
print 'message:'
636
if not rev.message:
637
print ' (no message)'
638
else:
639
for l in rev.message.split('\n'):
640
print ' ' + l
641
642
revno += 1
643
precursor = p
644
645
646
647
def show_status(branch, show_all=False):
648
"""Display single-line status for non-ignored working files.
649
650
The list is show sorted in order by file name.
651
652
>>> b = ScratchBranch(files=['foo', 'foo~'])
653
>>> b.show_status()
654
? foo
655
>>> b.add('foo')
656
>>> b.show_status()
657
A foo
658
>>> b.commit("add foo")
659
>>> b.show_status()
660
661
:todo: Get state for single files.
662
663
:todo: Perhaps show a slash at the end of directory names.
664
665
"""
666
667
# We have to build everything into a list first so that it can
668
# sorted by name, incorporating all the different sources.
669
670
# FIXME: Rather than getting things in random order and then sorting,
671
# just step through in order.
672
673
# Interesting case: the old ID for a file has been removed,
674
# but a new file has been created under that name.
675
676
old = branch.basis_tree()
677
old_inv = old.inventory
678
new = branch.working_tree()
679
new_inv = new.inventory
680
681
for fs, fid, oldname, newname, kind in diff_trees(old, new):
682
if fs == 'R':
683
show_status(fs, kind,
684
oldname + ' => ' + newname)
685
elif fs == 'A' or fs == 'M':
686
show_status(fs, kind, newname)
687
elif fs == 'D':
688
show_status(fs, kind, oldname)
689
elif fs == '.':
690
if show_all:
691
show_status(fs, kind, newname)
692
elif fs == 'I':
693
if show_all:
694
show_status(fs, kind, newname)
695
elif fs == '?':
696
show_status(fs, kind, newname)
697
else:
698
bailout("wierd file state %r" % ((fs, fid),))
699
1352
700
1353
701
1354
702
class ScratchBranch(Branch):
1358
706
>>> isdir(b.base)
1359
707
True
1360
708
>>> bd = b.base
1361
>>> b.destroy()
709
>>> del b
1362
710
>>> isdir(bd)
1363
711
False
1364
712
"""
1365
def __init__(self, files=[], dirs=[], base=None):
713
def __init__(self, files = []):
1366
714
"""Make a test branch.
1367
715
1368
716
This creates a temporary directory and runs init-tree in it.
1369
717
1370
718
If any files are listed, they are created in the working copy.
1371
719
"""
1372
from tempfile import mkdtemp
1373
init = False
1374
if base is None:
1375
base = mkdtemp()
1376
init = True
1377
Branch.__init__(self, base, init=init)
1378
for d in dirs:
1379
os.mkdir(self.abspath(d))
1380
720
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1381
721
for f in files:
1382
722
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1383
723
1384
724
1385
def clone(self):
1386
"""
1387
>>> orig = ScratchBranch(files=["file1", "file2"])
1388
>>> clone = orig.clone()
1389
>>> os.path.samefile(orig.base, clone.base)
1390
False
1391
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1392
True
1393
"""
1394
from shutil import copytree
1395
from tempfile import mkdtemp
1396
base = mkdtemp()
1397
os.rmdir(base)
1398
copytree(self.base, base, symlinks=True)
1399
return ScratchBranch(base=base)
1400
1401
1402
1403
725
def __del__(self):
1404
self.destroy()
1405
1406
def destroy(self):
1407
726
"""Destroy the test branch, removing the scratch directory."""
1408
from shutil import rmtree
1409
try:
1410
if self.base:
1411
mutter("delete ScratchBranch %s" % self.base)
1412
rmtree(self.base)
1413
except OSError, e:
1414
# Work around for shutil.rmtree failing on Windows when
1415
# readonly files are encountered
1416
mutter("hit exception in destroying ScratchBranch: %s" % e)
1417
for root, dirs, files in os.walk(self.base, topdown=False):
1418
for name in files:
1419
os.chmod(os.path.join(root, name), 0700)
1420
rmtree(self.base)
1421
self.base = None
727
shutil.rmtree(self.base)
1422
728
1423
729
1424
730
1434
740
## mutter('check %r for control file' % ((head, tail), ))
1435
741
if tail == bzrlib.BZRDIR:
1436
742
return True
1437
if filename == head:
1438
break
1439
743
filename = head
1440
744
return False
1441
745
1442
746
1443
747
1444
def gen_file_id(name):
748
def _gen_revision_id(when):
749
"""Return new revision-id."""
750
s = '%s-%s-' % (user_email(), compact_date(when))
751
s += hexlify(rand_bytes(8))
752
return s
753
754
755
def _gen_file_id(name):
1445
756
"""Return new file id.
1446
757
1447
758
This should probably generate proper UUIDs, but for the moment we
1448
759
cope with just randomness because running uuidgen every time is
1449
760
slow."""
1450
import re
1451
from binascii import hexlify
1452
from time import time
1453
1454
# get last component
1455
idx = name.rfind('/')
1456
if idx != -1:
1457
name = name[idx+1 : ]
1458
idx = name.rfind('\\')
1459
if idx != -1:
1460
name = name[idx+1 : ]
1461
1462
# make it not a hidden file
1463
name = name.lstrip('.')
1464
1465
# remove any wierd characters; we don't escape them but rather
1466
# just pull them out
1467
name = re.sub(r'[^\w.]', '', name)
1468
761
assert '/' not in name
762
while name[0] == '.':
763
name = name[1:]
1469
764
s = hexlify(rand_bytes(8))
1470
return '-'.join((name, compact_date(time()), s))
1471
1472
1473
def gen_root_id():
1474
"""Return a new tree-root file id."""
1475
return gen_file_id('TREE_ROOT')
1476
1477
1478
def pull_loc(branch):
1479
# TODO: Should perhaps just make attribute be 'base' in
1480
# RemoteBranch and Branch?
1481
if hasattr(branch, "baseurl"):
1482
return branch.baseurl
1483
else:
1484
return branch.base
1485
1486
1487
def copy_branch(branch_from, to_location, revision=None):
1488
"""Copy branch_from into the existing directory to_location.
1489
1490
revision
1491
If not None, only revisions up to this point will be copied.
1492
The head of the new branch will be that revision.
1493
1494
to_location
1495
The name of a local directory that exists but is empty.
1496
"""
1497
from bzrlib.merge import merge
1498
from bzrlib.branch import Branch
1499
1500
assert isinstance(branch_from, Branch)
1501
assert isinstance(to_location, basestring)
1502
1503
br_to = Branch(to_location, init=True)
1504
br_to.set_root_id(branch_from.get_root_id())
1505
if revision is None:
1506
revno = branch_from.revno()
1507
else:
1508
revno, rev_id = branch_from.get_revision_info(revision)
1509
br_to.update_revisions(branch_from, stop_revision=revno)
1510
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1511
check_clean=False, ignore_zero=True)
1512
1513
from_location = pull_loc(branch_from)
1514
br_to.set_parent(pull_loc(branch_from))
765
return '-'.join((name, compact_date(time.time()), s))
766
1515
767
Loggerhead is a web-based interface for Breezy
Version: 2.0.1