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