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