« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 1544
- compare with another revision
- download diff
- download tarball
- view history from revision 1544
- Committer: Martin Pool
- Date: 2006-01-13 06:31:42 UTC
- Revision ID: mbp@sourcefrog.net-20060113063142-8e706dc1483c69e1
Bump version to 0.8pre
- files added:
- .rsyncexclude
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/elementtree
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files removed:
- bzrlib/tests.py
- files renamed:
- bzrlib/store.py => bzrlib/store/__init__.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/branch.py
1
#! /usr/bin/env python
2
# -*- coding: UTF-8 -*-
1
# Copyright (C) 2005 Canonical Ltd
3
2
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
16
18
17
19
from sets import Set
18
import shutil
19
import sys
20
import os
21
import errno
22
from warnings import warn
23
from cStringIO import StringIO
20
24
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
25
25
26
import bzrlib
26
from inventory import Inventory
27
from trace import mutter, note
28
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
29
from inventory import InventoryEntry, Inventory
30
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
31
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
32
joinpath, sha_string, file_kind, local_time_offset
33
from store import ImmutableStore
34
from revision import Revision
35
from errors import bailout
36
from textui import show_status
37
from diff import diff_trees
38
39
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
import bzrlib.inventory as inventory
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn,
30
rename, splitpath, sha_file,
31
file_kind, abspath, normpath, pathjoin)
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError,
37
NoWorkingTree)
38
from bzrlib.textui import show_status
39
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
40
NULL_REVISION)
41
42
from bzrlib.delta import compare_trees
43
from bzrlib.tree import EmptyTree, RevisionTree
44
from bzrlib.inventory import Inventory
45
from bzrlib.store import copy_all
46
from bzrlib.store.text import TextStore
47
from bzrlib.store.weave import WeaveStore
48
from bzrlib.testament import Testament
49
import bzrlib.transactions as transactions
50
from bzrlib.transport import Transport, get_transport
51
import bzrlib.xml5
52
import bzrlib.ui
53
from config import TreeConfig
54
55
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
40
59
## TODO: Maybe include checks for common corruption of newlines, etc?
41
60
42
61
43
44
62
# TODO: Some operations like log might retrieve the same revisions
63
# repeatedly to calculate deltas. We could perhaps have a weakref
64
# cache in memory to make this faster. In general anything can be
65
# cached in memory between lock and unlock operations.
66
67
def find_branch(*ignored, **ignored_too):
68
# XXX: leave this here for about one release, then remove it
69
raise NotImplementedError('find_branch() is not supported anymore, '
70
'please use one of the new branch constructors')
71
72
73
def needs_read_lock(unbound):
74
"""Decorate unbound to take out and release a read lock."""
75
def decorated(self, *args, **kwargs):
76
self.lock_read()
77
try:
78
return unbound(self, *args, **kwargs)
79
finally:
80
self.unlock()
81
return decorated
82
83
84
def needs_write_lock(unbound):
85
"""Decorate unbound to take out and release a write lock."""
86
def decorated(self, *args, **kwargs):
87
self.lock_write()
88
try:
89
return unbound(self, *args, **kwargs)
90
finally:
91
self.unlock()
92
return decorated
45
93
46
94
######################################################################
47
95
# branch objects
48
96
49
class Branch:
97
class Branch(object):
50
98
"""Branch holding a history of revisions.
51
99
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):
100
base
101
Base directory/url of the branch.
102
"""
103
base = None
104
105
def __init__(self, *ignored, **ignored_too):
106
raise NotImplementedError('The Branch class is abstract')
107
108
@staticmethod
109
def open_downlevel(base):
110
"""Open a branch which may be of an old format.
111
112
Only local branches are supported."""
113
return BzrBranch(get_transport(base), relax_version_check=True)
114
115
@staticmethod
116
def open(base):
117
"""Open an existing branch, rooted at 'base' (url)"""
118
t = get_transport(base)
119
mutter("trying to open %r with transport %r", base, t)
120
return BzrBranch(t)
121
122
@staticmethod
123
def open_containing(url):
124
"""Open an existing branch which contains url.
125
126
This probes for a branch at url, and searches upwards from there.
127
128
Basically we keep looking up until we find the control directory or
129
run into the root. If there isn't one, raises NotBranchError.
130
If there is one, it is returned, along with the unused portion of url.
131
"""
132
t = get_transport(url)
133
while True:
134
try:
135
return BzrBranch(t), t.relpath(url)
136
except NotBranchError, e:
137
mutter('not a branch in: %r %s', t.base, e)
138
new_t = t.clone('..')
139
if new_t.base == t.base:
140
# reached the root, whatever that may be
141
raise NotBranchError(path=url)
142
t = new_t
143
144
@staticmethod
145
def initialize(base):
146
"""Create a new branch, rooted at 'base' (url)"""
147
t = get_transport(base)
148
return BzrBranch(t, init=True)
149
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
153
"""
154
self.cache_root = cache_root
155
156
def _get_nick(self):
157
cfg = self.tree_config()
158
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
159
160
def _set_nick(self, nick):
161
cfg = self.tree_config()
162
cfg.set_option(nick, "nickname")
163
assert cfg.get_option("nickname") == nick
164
165
nick = property(_get_nick, _set_nick)
166
167
def push_stores(self, branch_to):
168
"""Copy the content of this branches store to branch_to."""
169
raise NotImplementedError('push_stores is abstract')
170
171
def get_transaction(self):
172
"""Return the current active transaction.
173
174
If no transaction is active, this returns a passthrough object
175
for which all data is immediately flushed and no caching happens.
176
"""
177
raise NotImplementedError('get_transaction is abstract')
178
179
def lock_write(self):
180
raise NotImplementedError('lock_write is abstract')
181
182
def lock_read(self):
183
raise NotImplementedError('lock_read is abstract')
184
185
def unlock(self):
186
raise NotImplementedError('unlock is abstract')
187
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
190
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
193
"""
194
raise NotImplementedError('abspath is abstract')
195
196
def controlfilename(self, file_or_path):
197
"""Return location relative to branch."""
198
raise NotImplementedError('controlfilename is abstract')
199
200
def controlfile(self, file_or_path, mode='r'):
201
"""Open a control file for this branch.
202
203
There are two classes of file in the control directory: text
204
and binary. binary files are untranslated byte streams. Text
205
control files are stored with Unix newlines and in UTF-8, even
206
if the platform or locale defaults are different.
207
208
Controlfiles should almost never be opened in write mode but
209
rather should be atomically copied and replaced using atomicfile.
210
"""
211
raise NotImplementedError('controlfile is abstract')
212
213
def put_controlfile(self, path, f, encode=True):
214
"""Write an entry as a controlfile.
215
216
:param path: The path to put the file, relative to the .bzr control
217
directory
218
:param f: A file-like or string object whose contents should be copied.
219
:param encode: If true, encode the contents as utf-8
220
"""
221
raise NotImplementedError('put_controlfile is abstract')
222
223
def put_controlfiles(self, files, encode=True):
224
"""Write several entries as controlfiles.
225
226
:param files: A list of [(path, file)] pairs, where the path is the directory
227
underneath the bzr control directory
228
:param encode: If true, encode the contents as utf-8
229
"""
230
raise NotImplementedError('put_controlfiles is abstract')
231
232
def get_root_id(self):
233
"""Return the id of this branches root"""
234
raise NotImplementedError('get_root_id is abstract')
235
236
def set_root_id(self, file_id):
237
raise NotImplementedError('set_root_id is abstract')
238
239
def print_file(self, file, revision_id):
240
"""Print `file` to stdout."""
241
raise NotImplementedError('print_file is abstract')
242
243
def append_revision(self, *revision_ids):
244
raise NotImplementedError('append_revision is abstract')
245
246
def set_revision_history(self, rev_history):
247
raise NotImplementedError('set_revision_history is abstract')
248
249
def has_revision(self, revision_id):
250
"""True if this branch has a copy of the revision.
251
252
This does not necessarily imply the revision is merge
253
or on the mainline."""
254
raise NotImplementedError('has_revision is abstract')
255
256
def get_revision_xml(self, revision_id):
257
raise NotImplementedError('get_revision_xml is abstract')
258
259
def get_revision(self, revision_id):
260
"""Return the Revision object for a named revision"""
261
raise NotImplementedError('get_revision is abstract')
262
263
def get_revision_delta(self, revno):
264
"""Return the delta for one revision.
265
266
The delta is relative to its mainline predecessor, or the
267
empty tree for revision 1.
268
"""
269
assert isinstance(revno, int)
270
rh = self.revision_history()
271
if not (1 <= revno <= len(rh)):
272
raise InvalidRevisionNumber(revno)
273
274
# revno is 1-based; list is 0-based
275
276
new_tree = self.revision_tree(rh[revno-1])
277
if revno == 1:
278
old_tree = EmptyTree()
279
else:
280
old_tree = self.revision_tree(rh[revno-2])
281
282
return compare_trees(old_tree, new_tree)
283
284
def get_revision_sha1(self, revision_id):
285
"""Hash the stored value of a revision, and return it."""
286
raise NotImplementedError('get_revision_sha1 is abstract')
287
288
def get_ancestry(self, revision_id):
289
"""Return a list of revision-ids integrated by a revision.
290
291
This currently returns a list, but the ordering is not guaranteed:
292
treat it as a set.
293
"""
294
raise NotImplementedError('get_ancestry is abstract')
295
296
def get_inventory(self, revision_id):
297
"""Get Inventory object by hash."""
298
raise NotImplementedError('get_inventory is abstract')
299
300
def get_inventory_xml(self, revision_id):
301
"""Get inventory XML as a file object."""
302
raise NotImplementedError('get_inventory_xml is abstract')
303
304
def get_inventory_sha1(self, revision_id):
305
"""Return the sha1 hash of the inventory entry."""
306
raise NotImplementedError('get_inventory_sha1 is abstract')
307
308
def get_revision_inventory(self, revision_id):
309
"""Return inventory of a past revision."""
310
raise NotImplementedError('get_revision_inventory is abstract')
311
312
def revision_history(self):
313
"""Return sequence of revision hashes on to this branch."""
314
raise NotImplementedError('revision_history is abstract')
315
316
def revno(self):
317
"""Return current revision number for this branch.
318
319
That is equivalent to the number of revisions committed to
320
this branch.
321
"""
322
return len(self.revision_history())
323
324
def last_revision(self):
325
"""Return last patch hash, or None if no history."""
326
ph = self.revision_history()
327
if ph:
328
return ph[-1]
329
else:
330
return None
331
332
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
333
"""Return a list of new revisions that would perfectly fit.
334
335
If self and other have not diverged, return a list of the revisions
336
present in other, but missing from self.
337
338
>>> from bzrlib.commit import commit
339
>>> bzrlib.trace.silent = True
340
>>> br1 = ScratchBranch()
341
>>> br2 = ScratchBranch()
342
>>> br1.missing_revisions(br2)
343
[]
344
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
345
>>> br1.missing_revisions(br2)
346
[u'REVISION-ID-1']
347
>>> br2.missing_revisions(br1)
348
[]
349
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
350
>>> br1.missing_revisions(br2)
351
[]
352
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
353
>>> br1.missing_revisions(br2)
354
[u'REVISION-ID-2A']
355
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
356
>>> br1.missing_revisions(br2)
357
Traceback (most recent call last):
358
DivergedBranches: These branches have diverged. Try merge.
359
"""
360
self_history = self.revision_history()
361
self_len = len(self_history)
362
other_history = other.revision_history()
363
other_len = len(other_history)
364
common_index = min(self_len, other_len) -1
365
if common_index >= 0 and \
366
self_history[common_index] != other_history[common_index]:
367
raise DivergedBranches(self, other)
368
369
if stop_revision is None:
370
stop_revision = other_len
371
else:
372
assert isinstance(stop_revision, int)
373
if stop_revision > other_len:
374
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
375
return other_history[self_len:stop_revision]
376
377
def update_revisions(self, other, stop_revision=None):
378
"""Pull in new perfect-fit revisions."""
379
raise NotImplementedError('update_revisions is abstract')
380
381
def pullable_revisions(self, other, stop_revision):
382
raise NotImplementedError('pullable_revisions is abstract')
383
384
def revision_id_to_revno(self, revision_id):
385
"""Given a revision id, return its revno"""
386
if revision_id is None:
387
return 0
388
history = self.revision_history()
389
try:
390
return history.index(revision_id) + 1
391
except ValueError:
392
raise bzrlib.errors.NoSuchRevision(self, revision_id)
393
394
def get_rev_id(self, revno, history=None):
395
"""Find the revision id of the specified revno."""
396
if revno == 0:
397
return None
398
if history is None:
399
history = self.revision_history()
400
elif revno <= 0 or revno > len(history):
401
raise bzrlib.errors.NoSuchRevision(self, revno)
402
return history[revno - 1]
403
404
def revision_tree(self, revision_id):
405
"""Return Tree for a revision on this branch.
406
407
`revision_id` may be None for the null revision, in which case
408
an `EmptyTree` is returned."""
409
raise NotImplementedError('revision_tree is abstract')
410
411
def working_tree(self):
412
"""Return a `Tree` for the working copy if this is a local branch."""
413
raise NotImplementedError('working_tree is abstract')
414
415
def pull(self, source, overwrite=False):
416
raise NotImplementedError('pull is abstract')
417
418
def basis_tree(self):
419
"""Return `Tree` object for last revision.
420
421
If there are no revisions yet, return an `EmptyTree`.
422
"""
423
return self.revision_tree(self.last_revision())
424
425
def rename_one(self, from_rel, to_rel):
426
"""Rename one file.
427
428
This can change the directory or the filename or both.
429
"""
430
raise NotImplementedError('rename_one is abstract')
431
432
def move(self, from_paths, to_name):
433
"""Rename files.
434
435
to_name must exist as a versioned directory.
436
437
If to_name exists and is a directory, the files are moved into
438
it, keeping their old names. If it is a directory,
439
440
Note that to_name is only the last component of the new name;
441
this doesn't change the directory.
442
443
This returns a list of (from_path, to_path) pairs for each
444
entry that is moved.
445
"""
446
raise NotImplementedError('move is abstract')
447
448
def get_parent(self):
449
"""Return the parent location of the branch.
450
451
This is the default location for push/pull/missing. The usual
452
pattern is that the user can override it by specifying a
453
location.
454
"""
455
raise NotImplementedError('get_parent is abstract')
456
457
def get_push_location(self):
458
"""Return the None or the location to push this branch to."""
459
raise NotImplementedError('get_push_location is abstract')
460
461
def set_push_location(self, location):
462
"""Set a new push location for this branch."""
463
raise NotImplementedError('set_push_location is abstract')
464
465
def set_parent(self, url):
466
raise NotImplementedError('set_parent is abstract')
467
468
def check_revno(self, revno):
469
"""\
470
Check whether a revno corresponds to any revision.
471
Zero (the NULL revision) is considered valid.
472
"""
473
if revno != 0:
474
self.check_real_revno(revno)
475
476
def check_real_revno(self, revno):
477
"""\
478
Check whether a revno corresponds to a real revision.
479
Zero (the NULL revision) is considered invalid
480
"""
481
if revno < 1 or revno > self.revno():
482
raise InvalidRevisionNumber(revno)
483
484
def sign_revision(self, revision_id, gpg_strategy):
485
raise NotImplementedError('sign_revision is abstract')
486
487
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
488
raise NotImplementedError('store_revision_signature is abstract')
489
490
class BzrBranch(Branch):
491
"""A branch stored in the actual filesystem.
492
493
Note that it's "local" in the context of the filesystem; it doesn't
494
really matter if it's on an nfs/smb/afs/coda/... share, as long as
495
it's writable, and can be accessed via the normal filesystem API.
496
497
_lock_mode
498
None, or 'r' or 'w'
499
500
_lock_count
501
If _lock_mode is true, a positive count of the number of times the
502
lock has been taken.
503
504
_lock
505
Lock object from bzrlib.lock.
506
"""
507
# We actually expect this class to be somewhat short-lived; part of its
508
# purpose is to try to isolate what bits of the branch logic are tied to
509
# filesystem access, so that in a later step, we can extricate them to
510
# a separarte ("storage") class.
511
_lock_mode = None
512
_lock_count = None
513
_lock = None
514
_inventory_weave = None
515
# If set to False (by a plugin, etc) BzrBranch will not set the
516
# mode on created files or directories
517
_set_file_mode = True
518
_set_dir_mode = True
519
520
# Map some sort of prefix into a namespace
521
# stuff like "revno:10", "revid:", etc.
522
# This should match a prefix with a function which accepts
523
REVISION_NAMESPACES = {}
524
525
def push_stores(self, branch_to):
526
"""See Branch.push_stores."""
527
if (self._branch_format != branch_to._branch_format
528
or self._branch_format != 4):
529
from bzrlib.fetch import greedy_fetch
530
mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
531
self, self._branch_format, branch_to, branch_to._branch_format)
532
greedy_fetch(to_branch=branch_to, from_branch=self,
533
revision=self.last_revision())
534
return
535
536
store_pairs = ((self.text_store, branch_to.text_store),
537
(self.inventory_store, branch_to.inventory_store),
538
(self.revision_store, branch_to.revision_store))
539
try:
540
for from_store, to_store in store_pairs:
541
copy_all(from_store, to_store)
542
except UnlistableStore:
543
raise UnlistableBranch(from_store)
544
545
def __init__(self, transport, init=False,
546
relax_version_check=False):
66
547
"""Create new branch object at a particular location.
67
548
68
:param base: Base directory for the branch.
69
70
:param init: If True, create new control files in a previously
549
transport -- A Transport object, defining how to access files.
550
551
init -- If True, create new control files in a previously
71
552
unversioned directory. If False, the branch must already
72
553
be versioned.
73
554
555
relax_version_check -- If true, the usual check for the branch
556
version is not applied. This is intended only for
557
upgrade/recovery type use; it's not guaranteed that
558
all operations will work on old format branches.
559
74
560
In the test suite, creation of new trees is tested using the
75
561
`ScratchBranch` class.
76
562
"""
77
self.base = os.path.realpath(base)
563
assert isinstance(transport, Transport), \
564
"%r is not a Transport" % transport
565
self._transport = transport
78
566
if init:
79
567
self._make_control()
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
568
self._check_format(relax_version_check)
569
self._find_modes()
570
571
def get_store(name, compressed=True, prefixed=False):
572
relpath = self._rel_controlfilename(unicode(name))
573
store = TextStore(self._transport.clone(relpath),
574
dir_mode=self._dir_mode,
575
file_mode=self._file_mode,
576
prefixed=prefixed,
577
compressed=compressed)
578
return store
579
580
def get_weave(name, prefixed=False):
581
relpath = self._rel_controlfilename(unicode(name))
582
ws = WeaveStore(self._transport.clone(relpath),
583
prefixed=prefixed,
584
dir_mode=self._dir_mode,
585
file_mode=self._file_mode)
586
if self._transport.should_cache():
587
ws.enable_cache = True
588
return ws
589
590
if self._branch_format == 4:
591
self.inventory_store = get_store('inventory-store')
592
self.text_store = get_store('text-store')
593
self.revision_store = get_store('revision-store')
594
elif self._branch_format == 5:
595
self.control_weaves = get_weave(u'')
596
self.weave_store = get_weave(u'weaves')
597
self.revision_store = get_store(u'revision-store', compressed=False)
598
elif self._branch_format == 6:
599
self.control_weaves = get_weave(u'')
600
self.weave_store = get_weave(u'weaves', prefixed=True)
601
self.revision_store = get_store(u'revision-store', compressed=False,
602
prefixed=True)
603
self.revision_store.register_suffix('sig')
604
self._transaction = None
91
605
92
606
def __str__(self):
93
return '%s(%r)' % (self.__class__.__name__, self.base)
94
607
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
95
608
96
609
__repr__ = __str__
97
610
98
99
def _rel(self, name):
100
"""Return filename relative to branch top"""
101
return os.path.join(self.base, name)
102
611
def __del__(self):
612
if self._lock_mode or self._lock:
613
# XXX: This should show something every time, and be suitable for
614
# headless operation and embedding
615
warn("branch %r was not explicitly unlocked" % self)
616
self._lock.unlock()
617
618
# TODO: It might be best to do this somewhere else,
619
# but it is nice for a Branch object to automatically
620
# cache it's information.
621
# Alternatively, we could have the Transport objects cache requests
622
# See the earlier discussion about how major objects (like Branch)
623
# should never expect their __del__ function to run.
624
if hasattr(self, 'cache_root') and self.cache_root is not None:
625
try:
626
shutil.rmtree(self.cache_root)
627
except:
628
pass
629
self.cache_root = None
630
631
def _get_base(self):
632
if self._transport:
633
return self._transport.base
634
return None
635
636
base = property(_get_base, doc="The URL for the root of this branch.")
637
638
def _finish_transaction(self):
639
"""Exit the current transaction."""
640
if self._transaction is None:
641
raise errors.LockError('Branch %s is not in a transaction' %
642
self)
643
transaction = self._transaction
644
self._transaction = None
645
transaction.finish()
646
647
def get_transaction(self):
648
"""See Branch.get_transaction."""
649
if self._transaction is None:
650
return transactions.PassThroughTransaction()
651
else:
652
return self._transaction
653
654
def _set_transaction(self, new_transaction):
655
"""Set a new active transaction."""
656
if self._transaction is not None:
657
raise errors.LockError('Branch %s is in a transaction already.' %
658
self)
659
self._transaction = new_transaction
660
661
def lock_write(self):
662
#mutter("lock write: %s (%s)", self, self._lock_count)
663
# TODO: Upgrade locking to support using a Transport,
664
# and potentially a remote locking protocol
665
if self._lock_mode:
666
if self._lock_mode != 'w':
667
raise LockError("can't upgrade to a write lock from %r" %
668
self._lock_mode)
669
self._lock_count += 1
670
else:
671
self._lock = self._transport.lock_write(
672
self._rel_controlfilename('branch-lock'))
673
self._lock_mode = 'w'
674
self._lock_count = 1
675
self._set_transaction(transactions.PassThroughTransaction())
676
677
def lock_read(self):
678
#mutter("lock read: %s (%s)", self, self._lock_count)
679
if self._lock_mode:
680
assert self._lock_mode in ('r', 'w'), \
681
"invalid lock mode %r" % self._lock_mode
682
self._lock_count += 1
683
else:
684
self._lock = self._transport.lock_read(
685
self._rel_controlfilename('branch-lock'))
686
self._lock_mode = 'r'
687
self._lock_count = 1
688
self._set_transaction(transactions.ReadOnlyTransaction())
689
# 5K may be excessive, but hey, its a knob.
690
self.get_transaction().set_cache_size(5000)
691
692
def unlock(self):
693
#mutter("unlock: %s (%s)", self, self._lock_count)
694
if not self._lock_mode:
695
raise LockError('branch %r is not locked' % (self))
696
697
if self._lock_count > 1:
698
self._lock_count -= 1
699
else:
700
self._finish_transaction()
701
self._lock.unlock()
702
self._lock = None
703
self._lock_mode = self._lock_count = None
704
705
def abspath(self, name):
706
"""See Branch.abspath."""
707
return self._transport.abspath(name)
708
709
def _rel_controlfilename(self, file_or_path):
710
if not isinstance(file_or_path, basestring):
711
file_or_path = u'/'.join(file_or_path)
712
if file_or_path == '':
713
return bzrlib.BZRDIR
714
return bzrlib.transport.urlescape(bzrlib.BZRDIR + u'/' + file_or_path)
103
715
104
716
def controlfilename(self, file_or_path):
105
"""Return location relative to branch."""
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)
109
717
"""See Branch.controlfilename."""
718
return self._transport.abspath(self._rel_controlfilename(file_or_path))
110
719
111
720
def controlfile(self, file_or_path, mode='r'):
112
"""Open a control file for this branch"""
113
return file(self.controlfilename(file_or_path), mode)
114
721
"""See Branch.controlfile."""
722
import codecs
723
724
relpath = self._rel_controlfilename(file_or_path)
725
#TODO: codecs.open() buffers linewise, so it was overloaded with
726
# a much larger buffer, do we need to do the same for getreader/getwriter?
727
if mode == 'rb':
728
return self._transport.get(relpath)
729
elif mode == 'wb':
730
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
731
elif mode == 'r':
732
# XXX: Do we really want errors='replace'? Perhaps it should be
733
# an error, or at least reported, if there's incorrectly-encoded
734
# data inside a file.
735
# <https://launchpad.net/products/bzr/+bug/3823>
736
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
737
elif mode == 'w':
738
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
739
else:
740
raise BzrError("invalid controlfile mode %r" % mode)
741
742
def put_controlfile(self, path, f, encode=True):
743
"""See Branch.put_controlfile."""
744
self.put_controlfiles([(path, f)], encode=encode)
745
746
def put_controlfiles(self, files, encode=True):
747
"""See Branch.put_controlfiles."""
748
import codecs
749
ctrl_files = []
750
for path, f in files:
751
if encode:
752
if isinstance(f, basestring):
753
f = f.encode('utf-8', 'replace')
754
else:
755
f = codecs.getwriter('utf-8')(f, errors='replace')
756
path = self._rel_controlfilename(path)
757
ctrl_files.append((path, f))
758
self._transport.put_multi(ctrl_files, mode=self._file_mode)
759
760
def _find_modes(self, path=None):
761
"""Determine the appropriate modes for files and directories."""
762
try:
763
if path is None:
764
path = self._rel_controlfilename('')
765
st = self._transport.stat(path)
766
except errors.TransportNotPossible:
767
self._dir_mode = 0755
768
self._file_mode = 0644
769
else:
770
self._dir_mode = st.st_mode & 07777
771
# Remove the sticky and execute bits for files
772
self._file_mode = self._dir_mode & ~07111
773
if not self._set_dir_mode:
774
self._dir_mode = None
775
if not self._set_file_mode:
776
self._file_mode = None
115
777
116
778
def _make_control(self):
117
os.mkdir(self.controlfilename([]))
118
self.controlfile('README', 'w').write(
779
from bzrlib.inventory import Inventory
780
from bzrlib.weavefile import write_weave_v5
781
from bzrlib.weave import Weave
782
783
# Create an empty inventory
784
sio = StringIO()
785
# if we want per-tree root ids then this is the place to set
786
# them; they're not needed for now and so ommitted for
787
# simplicity.
788
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
789
empty_inv = sio.getvalue()
790
sio = StringIO()
791
bzrlib.weavefile.write_weave_v5(Weave(), sio)
792
empty_weave = sio.getvalue()
793
794
cfn = self._rel_controlfilename
795
# Since we don't have a .bzr directory, inherit the
796
# mode from the root directory
797
self._find_modes(u'.')
798
799
dirs = ['', 'revision-store', 'weaves']
800
files = [('README',
119
801
"This is a Bazaar-NG control directory.\n"
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):
802
"Do not change any files in this directory.\n"),
803
('branch-format', BZR_BRANCH_FORMAT_6),
804
('revision-history', ''),
805
('branch-name', ''),
806
('branch-lock', ''),
807
('pending-merges', ''),
808
('inventory', empty_inv),
809
('inventory.weave', empty_weave),
810
('ancestry.weave', empty_weave)
811
]
812
self._transport.mkdir_multi([cfn(d) for d in dirs], mode=self._dir_mode)
813
self.put_controlfiles(files)
814
mutter('created control directory in ' + self._transport.base)
815
816
def _check_format(self, relax_version_check):
132
817
"""Check this branch format is supported.
133
818
134
The current tool only supports the current unstable format.
819
The format level is stored, as an integer, in
820
self._branch_format for code that needs to check it later.
135
821
136
822
In the future, we might need different in-memory Branch
137
823
classes to support downlevel branches. But not yet.
138
"""
139
# read in binary mode to detect newline wierdness.
140
fmt = self.controlfile('branch-format', 'rb').read()
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
146
147
def read_working_inventory(self):
148
"""Read the working inventory."""
149
before = time.time()
150
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
151
mutter("loaded inventory of %d items in %f"
152
% (len(inv), time.time() - before))
153
return inv
154
155
156
def _write_inventory(self, inv):
157
"""Update the working inventory.
158
159
That is to say, the inventory describing changes underway, that
160
will be committed to the next revision.
161
"""
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'))
168
mutter('wrote working inventory')
169
170
171
inventory = property(read_working_inventory, _write_inventory, None,
172
"""Inventory for the working copy.""")
173
174
175
def add(self, files, verbose=False):
176
"""Make files versioned.
177
178
This puts the files in the Added state, so that they will be
179
recorded by the next commit.
180
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', [])
214
"""
215
216
# TODO: Re-adding a file that is removed in the working copy
217
# should probably put it back with the previous ID.
218
if isinstance(files, types.StringTypes):
219
files = [files]
220
221
inv = self.read_working_inventory()
222
for f in files:
223
if is_control_file(f):
224
bailout("cannot add control file %s" % quotefn(f))
225
226
fp = splitpath(f)
227
228
if len(fp) == 0:
229
bailout("cannot add top-level %r" % f)
230
231
fullpath = os.path.normpath(self._rel(f))
232
233
if isfile(fullpath):
234
kind = 'file'
235
elif isdir(fullpath):
236
kind = 'directory'
237
else:
238
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
239
240
if len(fp) > 1:
241
parent_name = joinpath(fp[:-1])
242
mutter("lookup parent %r" % parent_name)
243
parent_id = inv.path2id(parent_name)
244
if parent_id == None:
245
bailout("cannot add: parent %r is not versioned"
246
% joinpath(fp[:-1]))
247
else:
248
parent_id = None
249
250
file_id = _gen_file_id(fp[-1])
251
inv.add(InventoryEntry(file_id, fp[-1], kind=kind, parent_id=parent_id))
252
if verbose:
253
show_status('A', kind, quotefn(f))
254
255
mutter("add file %s file_id:{%s} kind=%r parent_id={%s}"
256
% (f, file_id, kind, parent_id))
257
self._write_inventory(inv)
258
259
260
261
def remove(self, files, verbose=False):
262
"""Mark nominated files for removal from the inventory.
263
264
This does not remove their text. This does not run on
265
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
293
removing may be useful and the user can just use use rm, and
294
is the opposite of add. Removing it is consistent with most
295
other tools. Maybe an option.
296
"""
297
## TODO: Normalize names
298
## TODO: Remove nested loops; better scalability
299
300
if isinstance(files, types.StringTypes):
301
files = [files]
302
303
tree = self.working_tree()
304
inv = tree.inventory
305
306
# do this before any modifications
307
for f in files:
308
fid = inv.path2id(f)
309
if not fid:
310
bailout("cannot remove unversioned file %s" % quotefn(f))
311
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
312
if verbose:
313
# having remove it, it must be either ignored or unknown
314
if tree.is_ignored(f):
315
new_status = 'I'
316
else:
317
new_status = '?'
318
show_status(new_status, inv[fid].kind, quotefn(f))
319
del inv[fid]
320
321
self._write_inventory(inv)
322
323
324
def unknowns(self):
325
"""Return all unknown files.
326
327
These are files in the working directory that are not versioned or
328
control files or ignored.
329
330
>>> b = ScratchBranch(files=['foo', 'foo~'])
331
>>> list(b.unknowns())
332
['foo']
333
>>> b.add('foo')
334
>>> list(b.unknowns())
335
[]
336
>>> b.remove('foo')
337
>>> list(b.unknowns())
338
['foo']
339
"""
340
return self.working_tree().unknowns()
341
342
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!")
510
824
"""
825
try:
826
fmt = self.controlfile('branch-format', 'r').read()
827
except NoSuchFile:
828
raise NotBranchError(path=self.base)
829
mutter("got branch format %r", fmt)
830
if fmt == BZR_BRANCH_FORMAT_6:
831
self._branch_format = 6
832
elif fmt == BZR_BRANCH_FORMAT_5:
833
self._branch_format = 5
834
elif fmt == BZR_BRANCH_FORMAT_4:
835
self._branch_format = 4
836
837
if (not relax_version_check
838
and self._branch_format not in (5, 6)):
839
raise errors.UnsupportedFormatError(
840
'sorry, branch format %r not supported' % fmt,
841
['use a different bzr version',
842
'or remove the .bzr directory'
843
' and "bzr init" again'])
844
845
@needs_read_lock
846
def get_root_id(self):
847
"""See Branch.get_root_id."""
848
inv = self.get_inventory(self.last_revision())
849
return inv.root.file_id
850
851
@needs_read_lock
852
def print_file(self, file, revision_id):
853
"""See Branch.print_file."""
854
tree = self.revision_tree(revision_id)
855
# use inventory as it was in that revision
856
file_id = tree.inventory.path2id(file)
857
if not file_id:
858
try:
859
revno = self.revision_id_to_revno(revision_id)
860
except errors.NoSuchRevision:
861
# TODO: This should not be BzrError,
862
# but NoSuchFile doesn't fit either
863
raise BzrError('%r is not present in revision %s'
864
% (file, revision_id))
865
else:
866
raise BzrError('%r is not present in revision %s'
867
% (file, revno))
868
tree.print_file(file_id)
869
870
@needs_write_lock
871
def append_revision(self, *revision_ids):
872
"""See Branch.append_revision."""
873
for revision_id in revision_ids:
874
mutter("add {%s} to revision-history" % revision_id)
875
rev_history = self.revision_history()
876
rev_history.extend(revision_ids)
877
self.set_revision_history(rev_history)
878
879
@needs_write_lock
880
def set_revision_history(self, rev_history):
881
"""See Branch.set_revision_history."""
882
old_revision = self.last_revision()
883
new_revision = rev_history[-1]
884
self.put_controlfile('revision-history', '\n'.join(rev_history))
885
try:
886
self.working_tree().set_last_revision(new_revision, old_revision)
887
except NoWorkingTree:
888
mutter('Unable to set_last_revision without a working tree.')
889
890
def has_revision(self, revision_id):
891
"""See Branch.has_revision."""
892
return (revision_id is None
893
or self.revision_store.has_id(revision_id))
894
895
@needs_read_lock
896
def _get_revision_xml_file(self, revision_id):
897
if not revision_id or not isinstance(revision_id, basestring):
898
raise InvalidRevisionId(revision_id=revision_id, branch=self)
899
try:
900
return self.revision_store.get(revision_id)
901
except (IndexError, KeyError):
902
raise bzrlib.errors.NoSuchRevision(self, revision_id)
903
904
def get_revision_xml(self, revision_id):
905
"""See Branch.get_revision_xml."""
906
return self._get_revision_xml_file(revision_id).read()
511
907
512
908
def get_revision(self, revision_id):
513
"""Return the Revision object for a named revision"""
514
r = Revision.read_xml(self.revision_store[revision_id])
909
"""See Branch.get_revision."""
910
xml_file = self._get_revision_xml_file(revision_id)
911
912
try:
913
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
914
except SyntaxError, e:
915
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
916
[revision_id,
917
str(e)])
918
515
919
assert r.revision_id == revision_id
516
920
return r
517
921
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
528
529
def get_revision_inventory(self, revision_id):
530
"""Return inventory of a past revision."""
531
if revision_id == None:
532
return Inventory()
533
else:
534
return self.get_inventory(self.get_revision(revision_id).inventory_id)
535
536
537
def revision_history(self):
538
"""Return sequence of revision hashes on to this branch.
539
540
>>> ScratchBranch().revision_history()
541
[]
542
"""
543
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
544
545
546
def revno(self):
547
"""Return current revision number for this branch.
548
549
That is equivalent to the number of revisions committed to
550
this branch.
551
552
>>> b = ScratchBranch()
553
>>> b.revno()
554
0
555
>>> b.commit('no foo')
556
>>> b.revno()
557
1
558
"""
559
return len(self.revision_history())
560
561
562
def last_patch(self):
563
"""Return last patch hash, or None if no history.
564
565
>>> ScratchBranch().last_patch() == None
566
True
567
"""
568
ph = self.revision_history()
569
if ph:
570
return ph[-1]
571
572
573
def lookup_revision(self, revno):
574
"""Return revision hash for revision number."""
575
if revno == 0:
576
return None
577
922
def get_revision_sha1(self, revision_id):
923
"""See Branch.get_revision_sha1."""
924
# In the future, revision entries will be signed. At that
925
# point, it is probably best *not* to include the signature
926
# in the revision hash. Because that lets you re-sign
927
# the revision, (add signatures/remove signatures) and still
928
# have all hash pointers stay consistent.
929
# But for now, just hash the contents.
930
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
931
932
def get_ancestry(self, revision_id):
933
"""See Branch.get_ancestry."""
934
if revision_id is None:
935
return [None]
936
w = self._get_inventory_weave()
937
return [None] + map(w.idx_to_name,
938
w.inclusions([w.lookup(revision_id)]))
939
940
def _get_inventory_weave(self):
941
return self.control_weaves.get_weave('inventory',
942
self.get_transaction())
943
944
def get_inventory(self, revision_id):
945
"""See Branch.get_inventory."""
946
xml = self.get_inventory_xml(revision_id)
947
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
948
949
def get_inventory_xml(self, revision_id):
950
"""See Branch.get_inventory_xml."""
578
951
try:
579
# list is 0-based; revisions are 1-based
580
return self.revision_history()[revno-1]
952
assert isinstance(revision_id, basestring), type(revision_id)
953
iw = self._get_inventory_weave()
954
return iw.get_text(iw.lookup(revision_id))
581
955
except IndexError:
582
bailout("no such revision %s" % revno)
583
584
956
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
957
958
def get_inventory_sha1(self, revision_id):
959
"""See Branch.get_inventory_sha1."""
960
return self.get_revision(revision_id).inventory_sha1
961
962
def get_revision_inventory(self, revision_id):
963
"""See Branch.get_revision_inventory."""
964
# TODO: Unify this with get_inventory()
965
# bzr 0.0.6 and later imposes the constraint that the inventory_id
966
# must be the same as its revision, so this is trivial.
967
if revision_id == None:
968
# This does not make sense: if there is no revision,
969
# then it is the current tree inventory surely ?!
970
# and thus get_root_id() is something that looks at the last
971
# commit on the branch, and the get_root_id is an inventory check.
972
raise NotImplementedError
973
# return Inventory(self.get_root_id())
974
else:
975
return self.get_inventory(revision_id)
976
977
@needs_read_lock
978
def revision_history(self):
979
"""See Branch.revision_history."""
980
transaction = self.get_transaction()
981
history = transaction.map.find_revision_history()
982
if history is not None:
983
mutter("cache hit for revision-history in %s", self)
984
return list(history)
985
history = [l.rstrip('\r\n') for l in
986
self.controlfile('revision-history', 'r').readlines()]
987
transaction.map.add_revision_history(history)
988
# this call is disabled because revision_history is
989
# not really an object yet, and the transaction is for objects.
990
# transaction.register_clean(history, precious=True)
991
return list(history)
992
993
def update_revisions(self, other, stop_revision=None):
994
"""See Branch.update_revisions."""
995
from bzrlib.fetch import greedy_fetch
996
if stop_revision is None:
997
stop_revision = other.last_revision()
998
### Should this be checking is_ancestor instead of revision_history?
999
if (stop_revision is not None and
1000
stop_revision in self.revision_history()):
1001
return
1002
greedy_fetch(to_branch=self, from_branch=other,
1003
revision=stop_revision)
1004
pullable_revs = self.pullable_revisions(other, stop_revision)
1005
if len(pullable_revs) > 0:
1006
self.append_revision(*pullable_revs)
1007
1008
def pullable_revisions(self, other, stop_revision):
1009
"""See Branch.pullable_revisions."""
1010
other_revno = other.revision_id_to_revno(stop_revision)
1011
try:
1012
return self.missing_revisions(other, other_revno)
1013
except DivergedBranches, e:
1014
try:
1015
pullable_revs = get_intervening_revisions(self.last_revision(),
1016
stop_revision, self)
1017
assert self.last_revision() not in pullable_revs
1018
return pullable_revs
1019
except bzrlib.errors.NotAncestor:
1020
if is_ancestor(self.last_revision(), stop_revision, self):
1021
return []
1022
else:
1023
raise e
1024
585
1025
def revision_tree(self, revision_id):
586
"""Return Tree for a revision on this branch.
587
588
`revision_id` may be None for the null revision, in which case
589
an `EmptyTree` is returned."""
590
591
if revision_id == None:
1026
"""See Branch.revision_tree."""
1027
# TODO: refactor this to use an existing revision object
1028
# so we don't need to read it in twice.
1029
if revision_id == None or revision_id == NULL_REVISION:
592
1030
return EmptyTree()
593
1031
else:
594
1032
inv = self.get_revision_inventory(revision_id)
595
return RevisionTree(self.text_store, inv)
1033
return RevisionTree(self, inv, revision_id)
596
1034
1035
def basis_tree(self):
1036
"""See Branch.basis_tree."""
1037
try:
1038
revision_id = self.revision_history()[-1]
1039
xml = self.working_tree().read_basis_inventory(revision_id)
1040
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
1041
return RevisionTree(self, inv, revision_id)
1042
except (IndexError, NoSuchFile, NoWorkingTree), e:
1043
return self.revision_tree(self.last_revision())
597
1044
598
1045
def working_tree(self):
599
"""Return a `Tree` for the working copy."""
600
return WorkingTree(self.base, self.read_working_inventory())
601
602
603
def basis_tree(self):
604
"""Return `Tree` object for last revision.
605
606
If there are no revisions yet, return an `EmptyTree`.
607
608
>>> b = ScratchBranch(files=['foo'])
609
>>> b.basis_tree().has_filename('foo')
610
False
611
>>> b.working_tree().has_filename('foo')
612
True
613
>>> b.add('foo')
614
>>> b.commit('add foo')
615
>>> b.basis_tree().has_filename('foo')
616
True
617
"""
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):
1046
"""See Branch.working_tree."""
1047
from bzrlib.workingtree import WorkingTree
1048
if self._transport.base.find('://') != -1:
1049
raise NoWorkingTree(self.base)
1050
return WorkingTree(self.base, branch=self)
1051
1052
@needs_write_lock
1053
def pull(self, source, overwrite=False):
1054
"""See Branch.pull."""
1055
source.lock_read()
1056
try:
1057
old_count = len(self.revision_history())
1058
try:
1059
self.update_revisions(source)
1060
except DivergedBranches:
1061
if not overwrite:
1062
raise
1063
if overwrite:
1064
self.set_revision_history(source.revision_history())
1065
new_count = len(self.revision_history())
1066
return new_count - old_count
1067
finally:
1068
source.unlock()
1069
1070
def get_parent(self):
1071
"""See Branch.get_parent."""
1072
import errno
1073
_locs = ['parent', 'pull', 'x-pull']
1074
for l in _locs:
1075
try:
1076
return self.controlfile(l, 'r').read().strip('\n')
1077
except NoSuchFile:
1078
pass
1079
return None
1080
1081
def get_push_location(self):
1082
"""See Branch.get_push_location."""
1083
config = bzrlib.config.BranchConfig(self)
1084
push_loc = config.get_user_option('push_location')
1085
return push_loc
1086
1087
def set_push_location(self, location):
1088
"""See Branch.set_push_location."""
1089
config = bzrlib.config.LocationConfig(self.base)
1090
config.set_user_option('push_location', location)
1091
1092
@needs_write_lock
1093
def set_parent(self, url):
1094
"""See Branch.set_parent."""
1095
# TODO: Maybe delete old location files?
1096
from bzrlib.atomicfile import AtomicFile
1097
f = AtomicFile(self.controlfilename('parent'))
1098
try:
1099
f.write(url + '\n')
1100
f.commit()
1101
finally:
1102
f.close()
1103
1104
def tree_config(self):
1105
return TreeConfig(self)
1106
1107
def sign_revision(self, revision_id, gpg_strategy):
1108
"""See Branch.sign_revision."""
1109
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1110
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1111
1112
@needs_write_lock
1113
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1114
"""See Branch.store_revision_signature."""
1115
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1116
revision_id, "sig")
1117
1118
1119
class ScratchBranch(BzrBranch):
719
1120
"""Special test class: a branch that cleans up after itself.
720
1121
721
1122
>>> b = ScratchBranch()
722
1123
>>> isdir(b.base)
723
1124
True
724
1125
>>> bd = b.base
725
>>> del b
1126
>>> b._transport.__del__()
726
1127
>>> isdir(bd)
727
1128
False
728
1129
"""
729
def __init__(self, files = []):
1130
1131
def __init__(self, files=[], dirs=[], transport=None):
730
1132
"""Make a test branch.
731
1133
732
1134
This creates a temporary directory and runs init-tree in it.
733
1135
734
1136
If any files are listed, they are created in the working copy.
735
1137
"""
736
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1138
if transport is None:
1139
transport = bzrlib.transport.local.ScratchTransport()
1140
super(ScratchBranch, self).__init__(transport, init=True)
1141
else:
1142
super(ScratchBranch, self).__init__(transport)
1143
1144
for d in dirs:
1145
self._transport.mkdir(d)
1146
737
1147
for f in files:
738
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
739
740
741
def __del__(self):
742
"""Destroy the test branch, removing the scratch directory."""
743
shutil.rmtree(self.base)
744
1148
self._transport.put(f, 'content of %s' % f)
1149
1150
1151
def clone(self):
1152
"""
1153
>>> orig = ScratchBranch(files=["file1", "file2"])
1154
>>> clone = orig.clone()
1155
>>> if os.name != 'nt':
1156
... os.path.samefile(orig.base, clone.base)
1157
... else:
1158
... orig.base == clone.base
1159
...
1160
False
1161
>>> os.path.isfile(pathjoin(clone.base, "file1"))
1162
True
1163
"""
1164
from shutil import copytree
1165
from bzrlib.osutils import mkdtemp
1166
base = mkdtemp()
1167
os.rmdir(base)
1168
copytree(self.base, base, symlinks=True)
1169
return ScratchBranch(
1170
transport=bzrlib.transport.local.ScratchTransport(base))
745
1171
746
1172
747
1173
######################################################################
750
1176
751
1177
def is_control_file(filename):
752
1178
## FIXME: better check
753
filename = os.path.normpath(filename)
1179
filename = normpath(filename)
754
1180
while filename != '':
755
1181
head, tail = os.path.split(filename)
756
1182
## mutter('check %r for control file' % ((head, tail), ))
757
1183
if tail == bzrlib.BZRDIR:
758
1184
return True
1185
if filename == head:
1186
break
759
1187
filename = head
760
1188
return False
761
762
763
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):
772
"""Return new file id.
773
774
This should probably generate proper UUIDs, but for the moment we
775
cope with just randomness because running uuidgen every time is
776
slow."""
777
assert '/' not in name
778
while name[0] == '.':
779
name = name[1:]
780
s = hexlify(rand_bytes(8))
781
return '-'.join((name, compact_date(time.time()), s))
782
783
Loggerhead is a web-based interface for Breezy
Version: 2.0.1