~bzr-pqm/bzr/bzr.dev

70 by mbp at sourcefrog
Prepare for smart recursive add.
1
# Copyright (C) 2005 Canonical Ltd
2
1 by mbp at sourcefrog
import from baz patch-364
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
18
import sys
19
import os
1371 by Martin Pool
- raise NotBranchError if format file can't be read
20
import errno
1372 by Martin Pool
- avoid converting inventories to/from StringIO
21
from warnings import warn
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
22
from cStringIO import StringIO
1372 by Martin Pool
- avoid converting inventories to/from StringIO
23
1 by mbp at sourcefrog
import from baz patch-364
24
25
import bzrlib
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
26
from bzrlib.inventory import InventoryEntry
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
27
import bzrlib.inventory as inventory
800 by Martin Pool
Merge John's import-speedup branch:
28
from bzrlib.trace import mutter, note
1390 by Robert Collins
pair programming worx... merge integration and weave
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes, 
30
                            rename, splitpath, sha_file, appendpath, 
31
                            file_kind)
1417.1.6 by Robert Collins
introduce transactions for grouping actions done to and with branches
32
import bzrlib.errors as errors
1192 by Martin Pool
- clean up code for retrieving stored inventories
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
1299 by Martin Pool
- tidy up imports
34
                           NoSuchRevision, HistoryMissing, NotBranchError,
1391 by Robert Collins
merge from integration
35
                           DivergedBranches, LockError, UnlistableStore,
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
36
                           UnlistableBranch, NoSuchFile)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
37
from bzrlib.textui import show_status
1185.12.44 by abentley
Restored branch convergence to bzr pull
38
from bzrlib.revision import Revision, is_ancestor, get_intervening_revisions
39
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
40
from bzrlib.delta import compare_trees
41
from bzrlib.tree import EmptyTree, RevisionTree
1192 by Martin Pool
- clean up code for retrieving stored inventories
42
from bzrlib.inventory import Inventory
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
43
from bzrlib.store import copy_all
44
from bzrlib.store.compressed_text import CompressedTextStore
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
45
from bzrlib.store.text import TextStore
1393.2.3 by John Arbash Meinel
Fixing typos, updating stores, getting tests to pass.
46
from bzrlib.store.weave import WeaveStore
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
47
from bzrlib.testament import Testament
1417.1.6 by Robert Collins
introduce transactions for grouping actions done to and with branches
48
import bzrlib.transactions as transactions
1393.2.4 by John Arbash Meinel
All tests pass.
49
from bzrlib.transport import Transport, get_transport
1189 by Martin Pool
- BROKEN: partial support for commit into weave
50
import bzrlib.xml5
1104 by Martin Pool
- Add a simple UIFactory
51
import bzrlib.ui
52
1094 by Martin Pool
- merge aaron's merge improvements 999..1008
53
1186 by Martin Pool
- start implementing v5 format; Branch refuses to operate on old branches
54
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
55
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
1429 by Robert Collins
merge in niemeyers prefixed-store patch
56
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
1 by mbp at sourcefrog
import from baz patch-364
57
## TODO: Maybe include checks for common corruption of newlines, etc?
58
59
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
60
# TODO: Some operations like log might retrieve the same revisions
61
# repeatedly to calculate deltas.  We could perhaps have a weakref
1223 by Martin Pool
- store inventories in weave
62
# cache in memory to make this faster.  In general anything can be
63
# cached in memory between lock and unlock operations.
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
64
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
65
def find_branch(*ignored, **ignored_too):
66
    # XXX: leave this here for about one release, then remove it
67
    raise NotImplementedError('find_branch() is not supported anymore, '
68
                              'please use one of the new branch constructors')
416 by Martin Pool
- bzr log and bzr root now accept an http URL
69
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
70
71
def needs_read_lock(unbound):
72
    """Decorate unbound to take out and release a read lock."""
73
    def decorated(self, *args, **kwargs):
74
        self.lock_read()
75
        try:
76
            return unbound(self, *args, **kwargs)
77
        finally:
78
            self.unlock()
79
    return decorated
80
81
82
def needs_write_lock(unbound):
83
    """Decorate unbound to take out and release a write lock."""
84
    def decorated(self, *args, **kwargs):
85
        self.lock_write()
86
        try:
87
            return unbound(self, *args, **kwargs)
88
        finally:
89
            self.unlock()
90
    return decorated
91
1 by mbp at sourcefrog
import from baz patch-364
92
######################################################################
93
# branch objects
94
558 by Martin Pool
- All top-level classes inherit from object
95
class Branch(object):
1 by mbp at sourcefrog
import from baz patch-364
96
    """Branch holding a history of revisions.
97
343 by Martin Pool
doc
98
    base
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
99
        Base directory/url of the branch.
100
    """
101
    base = None
102
103
    def __init__(self, *ignored, **ignored_too):
104
        raise NotImplementedError('The Branch class is abstract')
105
106
    @staticmethod
1393.1.2 by Martin Pool
- better representation in Branch factories of opening old formats
107
    def open_downlevel(base):
108
        """Open a branch which may be of an old format.
109
        
110
        Only local branches are supported."""
1393.1.16 by Martin Pool
- fix up Branch.open_downlevel for Transport
111
        return _Branch(get_transport(base), relax_version_check=True)
1393.1.2 by Martin Pool
- better representation in Branch factories of opening old formats
112
        
113
    @staticmethod
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
114
    def open(base):
115
        """Open an existing branch, rooted at 'base' (url)"""
1393.2.4 by John Arbash Meinel
All tests pass.
116
        t = get_transport(base)
1393.1.63 by Martin Pool
- add some trace statements
117
        mutter("trying to open %r with transport %r", base, t)
1185.11.11 by John Arbash Meinel
Removing the remotebranch object.
118
        return _Branch(t)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
119
120
    @staticmethod
1185.2.8 by Lalo Martins
creating the new branch constructors
121
    def open_containing(url):
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
122
        """Open an existing branch which contains url.
123
        
124
        This probes for a branch at url, and searches upwards from there.
1185.17.2 by Martin Pool
[pick] avoid problems in fetching when .bzr is not listable
125
126
        Basically we keep looking up until we find the control directory or
127
        run into the root.  If there isn't one, raises NotBranchError.
1442.1.64 by Robert Collins
Branch.open_containing now returns a tuple (Branch, relative-path).
128
        If there is one, it is returned, along with the unused portion of url.
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
129
        """
1393.2.4 by John Arbash Meinel
All tests pass.
130
        t = get_transport(url)
1185.17.2 by Martin Pool
[pick] avoid problems in fetching when .bzr is not listable
131
        while True:
132
            try:
1442.1.64 by Robert Collins
Branch.open_containing now returns a tuple (Branch, relative-path).
133
                return _Branch(t), t.relpath(url)
1185.17.2 by Martin Pool
[pick] avoid problems in fetching when .bzr is not listable
134
            except NotBranchError:
135
                pass
136
            new_t = t.clone('..')
137
            if new_t.base == t.base:
138
                # reached the root, whatever that may be
139
                raise NotBranchError('%s is not in a branch' % url)
140
            t = new_t
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
141
142
    @staticmethod
143
    def initialize(base):
144
        """Create a new branch, rooted at 'base' (url)"""
1393.2.4 by John Arbash Meinel
All tests pass.
145
        t = get_transport(base)
1185.11.11 by John Arbash Meinel
Removing the remotebranch object.
146
        return _Branch(t, init=True)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
147
148
    def setup_caching(self, cache_root):
149
        """Subclasses that care about caching should override this, and set
150
        up cached stores located under cache_root.
151
        """
1400.1.1 by Robert Collins
implement a basic test for the ui branch command from http servers
152
        self.cache_root = cache_root
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
153
154
1185.11.11 by John Arbash Meinel
Removing the remotebranch object.
155
class _Branch(Branch):
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
156
    """A branch stored in the actual filesystem.
157
158
    Note that it's "local" in the context of the filesystem; it doesn't
159
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
160
    it's writable, and can be accessed via the normal filesystem API.
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
161
162
    _lock_mode
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
163
        None, or 'r' or 'w'
164
165
    _lock_count
166
        If _lock_mode is true, a positive count of the number of times the
167
        lock has been taken.
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
168
614 by Martin Pool
- unify two defintions of LockError
169
    _lock
170
        Lock object from bzrlib.lock.
1 by mbp at sourcefrog
import from baz patch-364
171
    """
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
172
    # We actually expect this class to be somewhat short-lived; part of its
173
    # purpose is to try to isolate what bits of the branch logic are tied to
174
    # filesystem access, so that in a later step, we can extricate them to
175
    # a separarte ("storage") class.
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
176
    _lock_mode = None
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
177
    _lock_count = None
615 by Martin Pool
Major rework of locking code:
178
    _lock = None
1223 by Martin Pool
- store inventories in weave
179
    _inventory_weave = None
353 by Martin Pool
- Per-branch locks in read and write modes.
180
    
897 by Martin Pool
- merge john's revision-naming code
181
    # Map some sort of prefix into a namespace
182
    # stuff like "revno:10", "revid:", etc.
183
    # This should match a prefix with a function which accepts
184
    REVISION_NAMESPACES = {}
185
1391 by Robert Collins
merge from integration
186
    def push_stores(self, branch_to):
187
        """Copy the content of this branches store to branch_to."""
188
        if (self._branch_format != branch_to._branch_format
189
            or self._branch_format != 4):
190
            from bzrlib.fetch import greedy_fetch
1393 by Robert Collins
reenable remotebranch tests
191
            mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
192
                   self, self._branch_format, branch_to, branch_to._branch_format)
1391 by Robert Collins
merge from integration
193
            greedy_fetch(to_branch=branch_to, from_branch=self,
194
                         revision=self.last_revision())
195
            return
196
197
        store_pairs = ((self.text_store,      branch_to.text_store),
198
                       (self.inventory_store, branch_to.inventory_store),
199
                       (self.revision_store,  branch_to.revision_store))
200
        try:
201
            for from_store, to_store in store_pairs: 
202
                copy_all(from_store, to_store)
203
        except UnlistableStore:
204
            raise UnlistableBranch(from_store)
205
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
206
    def __init__(self, transport, init=False,
1293 by Martin Pool
- add Branch constructor option to relax version check
207
                 relax_version_check=False):
1 by mbp at sourcefrog
import from baz patch-364
208
        """Create new branch object at a particular location.
209
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
210
        transport -- A Transport object, defining how to access files.
211
                (If a string, transport.transport() will be used to
212
                create a Transport object)
62 by mbp at sourcefrog
- new find_branch_root function; based on suggestion from aaron
213
        
254 by Martin Pool
- Doc cleanups from Magnus Therning
214
        init -- If True, create new control files in a previously
1 by mbp at sourcefrog
import from baz patch-364
215
             unversioned directory.  If False, the branch must already
216
             be versioned.
217
1293 by Martin Pool
- add Branch constructor option to relax version check
218
        relax_version_check -- If true, the usual check for the branch
219
            version is not applied.  This is intended only for
220
            upgrade/recovery type use; it's not guaranteed that
221
            all operations will work on old format branches.
222
1 by mbp at sourcefrog
import from baz patch-364
223
        In the test suite, creation of new trees is tested using the
224
        `ScratchBranch` class.
225
        """
1393.1.15 by Martin Pool
- better assertion message
226
        assert isinstance(transport, Transport), \
227
            "%r is not a Transport" % transport
907.1.8 by John Arbash Meinel
Changed the format for abspath. Updated branch to use a hidden _transport
228
        self._transport = transport
1 by mbp at sourcefrog
import from baz patch-364
229
        if init:
230
            self._make_control()
1293 by Martin Pool
- add Branch constructor option to relax version check
231
        self._check_format(relax_version_check)
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
232
1429 by Robert Collins
merge in niemeyers prefixed-store patch
233
        def get_store(name, compressed=True, prefixed=False):
1393.1.41 by Martin Pool
doc
234
            # FIXME: This approach of assuming stores are all entirely compressed
235
            # or entirely uncompressed is tidy, but breaks upgrade from 
236
            # some existing branches where there's a mixture; we probably 
237
            # still want the option to look for both.
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
238
            relpath = self._rel_controlfilename(name)
239
            if compressed:
1429 by Robert Collins
merge in niemeyers prefixed-store patch
240
                store = CompressedTextStore(self._transport.clone(relpath),
241
                                            prefixed=prefixed)
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
242
            else:
1429 by Robert Collins
merge in niemeyers prefixed-store patch
243
                store = TextStore(self._transport.clone(relpath),
244
                                  prefixed=prefixed)
1400.1.1 by Robert Collins
implement a basic test for the ui branch command from http servers
245
            #if self._transport.should_cache():
246
            #    cache_path = os.path.join(self.cache_root, name)
247
            #    os.mkdir(cache_path)
248
            #    store = bzrlib.store.CachedStore(store, cache_path)
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
249
            return store
1429 by Robert Collins
merge in niemeyers prefixed-store patch
250
        def get_weave(name, prefixed=False):
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
251
            relpath = self._rel_controlfilename(name)
1429 by Robert Collins
merge in niemeyers prefixed-store patch
252
            ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
253
            if self._transport.should_cache():
254
                ws.enable_cache = True
255
            return ws
256
1296 by Martin Pool
- v4 branch should allow access to inventory and text stores
257
        if self._branch_format == 4:
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
258
            self.inventory_store = get_store('inventory-store')
259
            self.text_store = get_store('text-store')
260
            self.revision_store = get_store('revision-store')
1390 by Robert Collins
pair programming worx... merge integration and weave
261
        elif self._branch_format == 5:
1393.2.3 by John Arbash Meinel
Fixing typos, updating stores, getting tests to pass.
262
            self.control_weaves = get_weave([])
263
            self.weave_store = get_weave('weaves')
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
264
            self.revision_store = get_store('revision-store', compressed=False)
1429 by Robert Collins
merge in niemeyers prefixed-store patch
265
        elif self._branch_format == 6:
266
            self.control_weaves = get_weave([])
267
            self.weave_store = get_weave('weaves', prefixed=True)
268
            self.revision_store = get_store('revision-store', compressed=False,
269
                                            prefixed=True)
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
270
        self.revision_store.register_suffix('sig')
1417.1.6 by Robert Collins
introduce transactions for grouping actions done to and with branches
271
        self._transaction = None
1 by mbp at sourcefrog
import from baz patch-364
272
273
    def __str__(self):
907.1.5 by John Arbash Meinel
Some more work, including ScratchBranch changes.
274
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
1 by mbp at sourcefrog
import from baz patch-364
275
276
277
    __repr__ = __str__
278
279
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
280
    def __del__(self):
615 by Martin Pool
Major rework of locking code:
281
        if self._lock_mode or self._lock:
1390 by Robert Collins
pair programming worx... merge integration and weave
282
            # XXX: This should show something every time, and be suitable for
283
            # headless operation and embedding
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
284
            warn("branch %r was not explicitly unlocked" % self)
615 by Martin Pool
Major rework of locking code:
285
            self._lock.unlock()
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
286
907.1.23 by John Arbash Meinel
Branch objects now automatically create Cached stores if the protocol is_remote.
287
        # TODO: It might be best to do this somewhere else,
288
        # but it is nice for a Branch object to automatically
289
        # cache it's information.
290
        # Alternatively, we could have the Transport objects cache requests
291
        # See the earlier discussion about how major objects (like Branch)
292
        # should never expect their __del__ function to run.
1185.11.9 by John Arbash Meinel
Most tests pass, some problems with unavailable socket recv
293
        if hasattr(self, 'cache_root') and self.cache_root is not None:
907.1.23 by John Arbash Meinel
Branch objects now automatically create Cached stores if the protocol is_remote.
294
            try:
295
                import shutil
296
                shutil.rmtree(self.cache_root)
297
            except:
298
                pass
299
            self.cache_root = None
300
907.1.17 by John Arbash Meinel
Adding a Branch.base property, removing pull_loc()
301
    def _get_base(self):
907.1.19 by John Arbash Meinel
Updated ScratchBranch and Branch.base, All Tests PASS !!!
302
        if self._transport:
303
            return self._transport.base
304
        return None
907.1.17 by John Arbash Meinel
Adding a Branch.base property, removing pull_loc()
305
1442.1.5 by Robert Collins
Give branch.base a docstring.
306
    base = property(_get_base, doc="The URL for the root of this branch.")
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
307
1417.1.6 by Robert Collins
introduce transactions for grouping actions done to and with branches
308
    def _finish_transaction(self):
309
        """Exit the current transaction."""
310
        if self._transaction is None:
311
            raise errors.LockError('Branch %s is not in a transaction' %
312
                                   self)
313
        transaction = self._transaction
314
        self._transaction = None
315
        transaction.finish()
316
317
    def get_transaction(self):
318
        """Return the current active transaction.
319
320
        If no transaction is active, this returns a passthrough object
321
        for which all data is immedaitely flushed and no caching happens.
322
        """
323
        if self._transaction is None:
324
            return transactions.PassThroughTransaction()
325
        else:
326
            return self._transaction
327
328
    def _set_transaction(self, new_transaction):
329
        """Set a new active transaction."""
330
        if self._transaction is not None:
331
            raise errors.LockError('Branch %s is in a transaction already.' %
332
                                   self)
333
        self._transaction = new_transaction
610 by Martin Pool
- replace Branch.lock(mode) with separate lock_read and lock_write
334
335
    def lock_write(self):
1437 by Robert Collins
lock during fetch, which is a separate code path to the special case of cloning
336
        mutter("lock write: %s (%s)", self, self._lock_count)
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
337
        # TODO: Upgrade locking to support using a Transport,
338
        # and potentially a remote locking protocol
610 by Martin Pool
- replace Branch.lock(mode) with separate lock_read and lock_write
339
        if self._lock_mode:
340
            if self._lock_mode != 'w':
341
                raise LockError("can't upgrade to a write lock from %r" %
342
                                self._lock_mode)
343
            self._lock_count += 1
344
        else:
907.1.24 by John Arbash Meinel
Remote functionality work.
345
            self._lock = self._transport.lock_write(
346
                    self._rel_controlfilename('branch-lock'))
610 by Martin Pool
- replace Branch.lock(mode) with separate lock_read and lock_write
347
            self._lock_mode = 'w'
348
            self._lock_count = 1
1417.1.6 by Robert Collins
introduce transactions for grouping actions done to and with branches
349
            self._set_transaction(transactions.PassThroughTransaction())
610 by Martin Pool
- replace Branch.lock(mode) with separate lock_read and lock_write
350
351
    def lock_read(self):
1437 by Robert Collins
lock during fetch, which is a separate code path to the special case of cloning
352
        mutter("lock read: %s (%s)", self, self._lock_count)
610 by Martin Pool
- replace Branch.lock(mode) with separate lock_read and lock_write
353
        if self._lock_mode:
354
            assert self._lock_mode in ('r', 'w'), \
355
                   "invalid lock mode %r" % self._lock_mode
356
            self._lock_count += 1
357
        else:
907.1.24 by John Arbash Meinel
Remote functionality work.
358
            self._lock = self._transport.lock_read(
359
                    self._rel_controlfilename('branch-lock'))
610 by Martin Pool
- replace Branch.lock(mode) with separate lock_read and lock_write
360
            self._lock_mode = 'r'
361
            self._lock_count = 1
1417.1.6 by Robert Collins
introduce transactions for grouping actions done to and with branches
362
            self._set_transaction(transactions.ReadOnlyTransaction())
1417.1.10 by Robert Collins
add a cache bound to Transactions, and a precious facility, so that we keep inventory.weave in memory, but can discard weaves for other such files.
363
            # 5K may be excessive, but hey, its a knob.
364
            self.get_transaction().set_cache_size(5000)
610 by Martin Pool
- replace Branch.lock(mode) with separate lock_read and lock_write
365
                        
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
366
    def unlock(self):
1437 by Robert Collins
lock during fetch, which is a separate code path to the special case of cloning
367
        mutter("unlock: %s (%s)", self, self._lock_count)
578 by Martin Pool
- start to move toward Branch.lock and unlock methods,
368
        if not self._lock_mode:
610 by Martin Pool
- replace Branch.lock(mode) with separate lock_read and lock_write
369
            raise LockError('branch %r is not locked' % (self))
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
370
371
        if self._lock_count > 1:
372
            self._lock_count -= 1
373
        else:
1417.1.6 by Robert Collins
introduce transactions for grouping actions done to and with branches
374
            self._finish_transaction()
615 by Martin Pool
Major rework of locking code:
375
            self._lock.unlock()
376
            self._lock = None
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
377
            self._lock_mode = self._lock_count = None
353 by Martin Pool
- Per-branch locks in read and write modes.
378
67 by mbp at sourcefrog
use abspath() for the function that makes an absolute
379
    def abspath(self, name):
1457.1.2 by Robert Collins
move branch._relpath into osutils as relpath
380
        """Return absolute filename for something in the branch
381
        
382
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
383
        method and not a tree method.
384
        """
907.1.5 by John Arbash Meinel
Some more work, including ScratchBranch changes.
385
        return self._transport.abspath(name)
67 by mbp at sourcefrog
use abspath() for the function that makes an absolute
386
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
387
    def _rel_controlfilename(self, file_or_path):
388
        if isinstance(file_or_path, basestring):
389
            file_or_path = [file_or_path]
390
        return [bzrlib.BZRDIR] + file_or_path
391
1 by mbp at sourcefrog
import from baz patch-364
392
    def controlfilename(self, file_or_path):
393
        """Return location relative to branch."""
907.1.8 by John Arbash Meinel
Changed the format for abspath. Updated branch to use a hidden _transport
394
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
1 by mbp at sourcefrog
import from baz patch-364
395
396
397
    def controlfile(self, file_or_path, mode='r'):
245 by mbp at sourcefrog
- control files always in utf-8-unix format
398
        """Open a control file for this branch.
399
400
        There are two classes of file in the control directory: text
401
        and binary.  binary files are untranslated byte streams.  Text
402
        control files are stored with Unix newlines and in UTF-8, even
403
        if the platform or locale defaults are different.
430 by Martin Pool
doc
404
405
        Controlfiles should almost never be opened in write mode but
406
        rather should be atomically copied and replaced using atomicfile.
245 by mbp at sourcefrog
- control files always in utf-8-unix format
407
        """
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
408
        import codecs
409
410
        relpath = self._rel_controlfilename(file_or_path)
411
        #TODO: codecs.open() buffers linewise, so it was overloaded with
412
        # a much larger buffer, do we need to do the same for getreader/getwriter?
413
        if mode == 'rb': 
907.1.8 by John Arbash Meinel
Changed the format for abspath. Updated branch to use a hidden _transport
414
            return self._transport.get(relpath)
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
415
        elif mode == 'wb':
907.1.50 by John Arbash Meinel
Removed encode/decode from Transport.put/get, added more exceptions that can be thrown.
416
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
417
        elif mode == 'r':
907.1.50 by John Arbash Meinel
Removed encode/decode from Transport.put/get, added more exceptions that can be thrown.
418
            return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
419
        elif mode == 'w':
907.1.50 by John Arbash Meinel
Removed encode/decode from Transport.put/get, added more exceptions that can be thrown.
420
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
245 by mbp at sourcefrog
- control files always in utf-8-unix format
421
        else:
422
            raise BzrError("invalid controlfile mode %r" % mode)
423
907.1.50 by John Arbash Meinel
Removed encode/decode from Transport.put/get, added more exceptions that can be thrown.
424
    def put_controlfile(self, path, f, encode=True):
907.1.20 by John Arbash Meinel
Removed Transport.open(), making get + put encode/decode to utf-8
425
        """Write an entry as a controlfile.
426
907.1.50 by John Arbash Meinel
Removed encode/decode from Transport.put/get, added more exceptions that can be thrown.
427
        :param path: The path to put the file, relative to the .bzr control
428
                     directory
429
        :param f: A file-like or string object whose contents should be copied.
430
        :param encode:  If true, encode the contents as utf-8
431
        """
432
        self.put_controlfiles([(path, f)], encode=encode)
433
434
    def put_controlfiles(self, files, encode=True):
435
        """Write several entries as controlfiles.
436
437
        :param files: A list of [(path, file)] pairs, where the path is the directory
438
                      underneath the bzr control directory
439
        :param encode:  If true, encode the contents as utf-8
440
        """
441
        import codecs
442
        ctrl_files = []
443
        for path, f in files:
444
            if encode:
445
                if isinstance(f, basestring):
446
                    f = f.encode('utf-8', 'replace')
447
                else:
448
                    f = codecs.getwriter('utf-8')(f, errors='replace')
449
            path = self._rel_controlfilename(path)
450
            ctrl_files.append((path, f))
451
        self._transport.put_multi(ctrl_files)
1 by mbp at sourcefrog
import from baz patch-364
452
453
    def _make_control(self):
800 by Martin Pool
Merge John's import-speedup branch:
454
        from bzrlib.inventory import Inventory
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
455
        from bzrlib.weavefile import write_weave_v5
456
        from bzrlib.weave import Weave
802 by Martin Pool
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
457
        
1185.11.1 by John Arbash Meinel
(broken) Transport work is merged in. Tests do not pass yet.
458
        # Create an empty inventory
907.1.47 by John Arbash Meinel
Created mkdir_multi, modified branch to use _multi forms when initializing a branch, creating a full test routine for transports
459
        sio = StringIO()
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
460
        # if we want per-tree root ids then this is the place to set
461
        # them; they're not needed for now and so ommitted for
462
        # simplicity.
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
463
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
464
        empty_inv = sio.getvalue()
465
        sio = StringIO()
466
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
467
        empty_weave = sio.getvalue()
907.1.47 by John Arbash Meinel
Created mkdir_multi, modified branch to use _multi forms when initializing a branch, creating a full test routine for transports
468
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
469
        dirs = [[], 'revision-store', 'weaves']
907.1.47 by John Arbash Meinel
Created mkdir_multi, modified branch to use _multi forms when initializing a branch, creating a full test routine for transports
470
        files = [('README', 
1 by mbp at sourcefrog
import from baz patch-364
471
            "This is a Bazaar-NG control directory.\n"
907.1.47 by John Arbash Meinel
Created mkdir_multi, modified branch to use _multi forms when initializing a branch, creating a full test routine for transports
472
            "Do not change any files in this directory.\n"),
1429 by Robert Collins
merge in niemeyers prefixed-store patch
473
            ('branch-format', BZR_BRANCH_FORMAT_6),
907.1.47 by John Arbash Meinel
Created mkdir_multi, modified branch to use _multi forms when initializing a branch, creating a full test routine for transports
474
            ('revision-history', ''),
475
            ('branch-name', ''),
476
            ('branch-lock', ''),
477
            ('pending-merges', ''),
1393.2.2 by John Arbash Meinel
Updated stores to use Transport
478
            ('inventory', empty_inv),
479
            ('inventory.weave', empty_weave),
480
            ('ancestry.weave', empty_weave)
907.1.47 by John Arbash Meinel
Created mkdir_multi, modified branch to use _multi forms when initializing a branch, creating a full test routine for transports
481
        ]
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
482
        cfn = self._rel_controlfilename
483
        self._transport.mkdir_multi([cfn(d) for d in dirs])
907.1.50 by John Arbash Meinel
Removed encode/decode from Transport.put/get, added more exceptions that can be thrown.
484
        self.put_controlfiles(files)
907.1.5 by John Arbash Meinel
Some more work, including ScratchBranch changes.
485
        mutter('created control directory in ' + self._transport.base)
802 by Martin Pool
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
486
1293 by Martin Pool
- add Branch constructor option to relax version check
487
    def _check_format(self, relax_version_check):
1 by mbp at sourcefrog
import from baz patch-364
488
        """Check this branch format is supported.
489
1187 by Martin Pool
- improved check for branch version
490
        The format level is stored, as an integer, in
491
        self._branch_format for code that needs to check it later.
1 by mbp at sourcefrog
import from baz patch-364
492
493
        In the future, we might need different in-memory Branch
494
        classes to support downlevel branches.  But not yet.
163 by mbp at sourcefrog
merge win32 portability fixes
495
        """
1185.11.9 by John Arbash Meinel
Most tests pass, some problems with unavailable socket recv
496
        try:
497
            fmt = self.controlfile('branch-format', 'r').read()
498
        except NoSuchFile:
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
499
            raise NotBranchError(self.base)
1393.1.63 by Martin Pool
- add some trace statements
500
        mutter("got branch format %r", fmt)
1429 by Robert Collins
merge in niemeyers prefixed-store patch
501
        if fmt == BZR_BRANCH_FORMAT_6:
502
            self._branch_format = 6
503
        elif fmt == BZR_BRANCH_FORMAT_5:
1187 by Martin Pool
- improved check for branch version
504
            self._branch_format = 5
1294 by Martin Pool
- refactor branch version detection
505
        elif fmt == BZR_BRANCH_FORMAT_4:
506
            self._branch_format = 4
507
508
        if (not relax_version_check
1429 by Robert Collins
merge in niemeyers prefixed-store patch
509
            and self._branch_format not in (5, 6)):
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
510
            raise errors.UnsupportedFormatError(
511
                           'sorry, branch format %r not supported' % fmt,
576 by Martin Pool
- raise exceptions rather than using bailout()
512
                           ['use a different bzr version',
1393.2.1 by John Arbash Meinel
Merged in split-storage-2 branch. Need to cleanup a little bit more still.
513
                            'or remove the .bzr directory'
514
                            ' and "bzr init" again'])
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
515
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
516
    def get_root_id(self):
517
        """Return the id of this branches root"""
518
        inv = self.read_working_inventory()
519
        return inv.root.file_id
1 by mbp at sourcefrog
import from baz patch-364
520
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
521
    def set_root_id(self, file_id):
522
        inv = self.read_working_inventory()
523
        orig_root_id = inv.root.file_id
524
        del inv._byid[inv.root.file_id]
525
        inv.root.file_id = file_id
526
        inv._byid[inv.root.file_id] = inv.root
527
        for fid in inv:
528
            entry = inv[fid]
529
            if entry.parent_id in (None, orig_root_id):
530
                entry.parent_id = inv.root.file_id
531
        self._write_inventory(inv)
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
532
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
533
    @needs_read_lock
1 by mbp at sourcefrog
import from baz patch-364
534
    def read_working_inventory(self):
535
        """Read the working inventory."""
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
536
        # ElementTree does its own conversion from UTF-8, so open in
537
        # binary.
538
        f = self.controlfile('inventory', 'rb')
539
        return bzrlib.xml5.serializer_v5.read_inventory(f)
1 by mbp at sourcefrog
import from baz patch-364
540
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
541
    @needs_write_lock
1 by mbp at sourcefrog
import from baz patch-364
542
    def _write_inventory(self, inv):
543
        """Update the working inventory.
544
545
        That is to say, the inventory describing changes underway, that
546
        will be committed to the next revision.
547
        """
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
548
        from cStringIO import StringIO
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
549
        sio = StringIO()
550
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
551
        sio.seek(0)
552
        # Transport handles atomicity
553
        self.put_controlfile('inventory', sio)
770 by Martin Pool
- write new working inventory using AtomicFile
554
        
14 by mbp at sourcefrog
write inventory to temporary file and atomically replace
555
        mutter('wrote working inventory')
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
556
            
1 by mbp at sourcefrog
import from baz patch-364
557
    inventory = property(read_working_inventory, _write_inventory, None,
558
                         """Inventory for the working copy.""")
559
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
560
    @needs_write_lock
1129 by Martin Pool
- Branch.add shouldn't write to stdout either
561
    def add(self, files, ids=None):
1 by mbp at sourcefrog
import from baz patch-364
562
        """Make files versioned.
563
1129 by Martin Pool
- Branch.add shouldn't write to stdout either
564
        Note that the command line normally calls smart_add instead,
565
        which can automatically recurse.
247 by mbp at sourcefrog
doc
566
1 by mbp at sourcefrog
import from baz patch-364
567
        This puts the files in the Added state, so that they will be
568
        recorded by the next commit.
569
596 by Martin Pool
doc
570
        files
571
            List of paths to add, relative to the base of the tree.
572
573
        ids
574
            If set, use these instead of automatically generated ids.
575
            Must be the same length as the list of files, but may
576
            contain None for ids that are to be autogenerated.
577
254 by Martin Pool
- Doc cleanups from Magnus Therning
578
        TODO: Perhaps have an option to add the ids even if the files do
596 by Martin Pool
doc
579
              not (yet) exist.
1 by mbp at sourcefrog
import from baz patch-364
580
1129 by Martin Pool
- Branch.add shouldn't write to stdout either
581
        TODO: Perhaps yield the ids and paths as they're added.
1 by mbp at sourcefrog
import from baz patch-364
582
        """
583
        # TODO: Re-adding a file that is removed in the working copy
584
        # should probably put it back with the previous ID.
800 by Martin Pool
Merge John's import-speedup branch:
585
        if isinstance(files, basestring):
586
            assert(ids is None or isinstance(ids, basestring))
1 by mbp at sourcefrog
import from baz patch-364
587
            files = [files]
493 by Martin Pool
- Merge aaron's merge command
588
            if ids is not None:
589
                ids = [ids]
590
591
        if ids is None:
592
            ids = [None] * len(files)
593
        else:
594
            assert(len(ids) == len(files))
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
595
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
596
        inv = self.read_working_inventory()
597
        for f,file_id in zip(files, ids):
598
            if is_control_file(f):
599
                raise BzrError("cannot add control file %s" % quotefn(f))
600
601
            fp = splitpath(f)
602
603
            if len(fp) == 0:
604
                raise BzrError("cannot add top-level %r" % f)
605
606
            fullpath = os.path.normpath(self.abspath(f))
607
608
            try:
609
                kind = file_kind(fullpath)
610
            except OSError:
611
                # maybe something better?
612
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
613
614
            if not InventoryEntry.versionable_kind(kind):
615
                raise BzrError('cannot add: not a versionable file ('
616
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
617
618
            if file_id is None:
619
                file_id = gen_file_id(f)
620
            inv.add_path(f, kind=kind, file_id=file_id)
621
622
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
623
624
        self._write_inventory(inv)
625
626
    @needs_read_lock
176 by mbp at sourcefrog
New cat command contributed by janmar.
627
    def print_file(self, file, revno):
628
        """Print `file` to stdout."""
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
629
        tree = self.revision_tree(self.get_rev_id(revno))
630
        # use inventory as it was in that revision
631
        file_id = tree.inventory.path2id(file)
632
        if not file_id:
633
            raise BzrError("%r is not present in revision %s" % (file, revno))
634
        tree.print_file(file_id)
635
636
    @needs_write_lock
1 by mbp at sourcefrog
import from baz patch-364
637
    def remove(self, files, verbose=False):
638
        """Mark nominated files for removal from the inventory.
639
640
        This does not remove their text.  This does not run on 
641
254 by Martin Pool
- Doc cleanups from Magnus Therning
642
        TODO: Refuse to remove modified files unless --force is given?
1 by mbp at sourcefrog
import from baz patch-364
643
254 by Martin Pool
- Doc cleanups from Magnus Therning
644
        TODO: Do something useful with directories.
1 by mbp at sourcefrog
import from baz patch-364
645
254 by Martin Pool
- Doc cleanups from Magnus Therning
646
        TODO: Should this remove the text or not?  Tough call; not
1 by mbp at sourcefrog
import from baz patch-364
647
        removing may be useful and the user can just use use rm, and
648
        is the opposite of add.  Removing it is consistent with most
649
        other tools.  Maybe an option.
650
        """
651
        ## TODO: Normalize names
652
        ## TODO: Remove nested loops; better scalability
800 by Martin Pool
Merge John's import-speedup branch:
653
        if isinstance(files, basestring):
1 by mbp at sourcefrog
import from baz patch-364
654
            files = [files]
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
655
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
656
        tree = self.working_tree()
657
        inv = tree.inventory
658
659
        # do this before any modifications
660
        for f in files:
661
            fid = inv.path2id(f)
662
            if not fid:
663
                raise BzrError("cannot remove unversioned file %s" % quotefn(f))
664
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
665
            if verbose:
666
                # having remove it, it must be either ignored or unknown
667
                if tree.is_ignored(f):
668
                    new_status = 'I'
669
                else:
670
                    new_status = '?'
671
                show_status(new_status, inv[fid].kind, quotefn(f))
672
            del inv[fid]
673
674
        self._write_inventory(inv)
611 by Martin Pool
- remove @with_writelock, @with_readlock decorators
675
612 by Martin Pool
doc
676
    # FIXME: this doesn't need to be a branch method
493 by Martin Pool
- Merge aaron's merge command
677
    def set_inventory(self, new_inventory_list):
800 by Martin Pool
Merge John's import-speedup branch:
678
        from bzrlib.inventory import Inventory, InventoryEntry
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
679
        inv = Inventory(self.get_root_id())
493 by Martin Pool
- Merge aaron's merge command
680
        for path, file_id, parent, kind in new_inventory_list:
681
            name = os.path.basename(path)
682
            if name == "":
683
                continue
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
684
            # fixme, there should be a factory function inv,add_?? 
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
685
            if kind == 'directory':
686
                inv.add(inventory.InventoryDirectory(file_id, name, parent))
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
687
            elif kind == 'file':
688
                inv.add(inventory.InventoryFile(file_id, name, parent))
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
689
            elif kind == 'symlink':
690
                inv.add(inventory.InventoryLink(file_id, name, parent))
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
691
            else:
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
692
                raise BzrError("unknown kind %r" % kind)
493 by Martin Pool
- Merge aaron's merge command
693
        self._write_inventory(inv)
694
1 by mbp at sourcefrog
import from baz patch-364
695
    def unknowns(self):
696
        """Return all unknown files.
697
698
        These are files in the working directory that are not versioned or
699
        control files or ignored.
700
        
701
        >>> b = ScratchBranch(files=['foo', 'foo~'])
702
        >>> list(b.unknowns())
703
        ['foo']
704
        >>> b.add('foo')
705
        >>> list(b.unknowns())
706
        []
707
        >>> b.remove('foo')
708
        >>> list(b.unknowns())
709
        ['foo']
710
        """
711
        return self.working_tree().unknowns()
712
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
713
    @needs_write_lock
905 by Martin Pool
- merge aaron's append_multiple.patch
714
    def append_revision(self, *revision_ids):
715
        for revision_id in revision_ids:
716
            mutter("add {%s} to revision-history" % revision_id)
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
717
        rev_history = self.revision_history()
718
        rev_history.extend(revision_ids)
719
        self.put_controlfile('revision-history', '\n'.join(rev_history))
233 by mbp at sourcefrog
- more output from test.sh
720
1261 by Martin Pool
- new method Branch.has_revision
721
    def has_revision(self, revision_id):
722
        """True if this branch has a copy of the revision.
723
724
        This does not necessarily imply the revision is merge
725
        or on the mainline."""
1390 by Robert Collins
pair programming worx... merge integration and weave
726
        return (revision_id is None
1442.1.45 by Robert Collins
replace __contains__ calls in stores with has_id
727
                or self.revision_store.has_id(revision_id))
1261 by Martin Pool
- new method Branch.has_revision
728
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
729
    @needs_read_lock
1182 by Martin Pool
- more disentangling of xml storage format from objects
730
    def get_revision_xml_file(self, revision_id):
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
731
        """Return XML file object for revision object."""
732
        if not revision_id or not isinstance(revision_id, basestring):
733
            raise InvalidRevisionId(revision_id)
734
        try:
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
735
            return self.revision_store.get(revision_id)
736
        except (IndexError, KeyError):
737
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
738
1182 by Martin Pool
- more disentangling of xml storage format from objects
739
    #deprecated
740
    get_revision_xml = get_revision_xml_file
741
1231 by Martin Pool
- more progress on fetch on top of weaves
742
    def get_revision_xml(self, revision_id):
743
        return self.get_revision_xml_file(revision_id).read()
744
745
1 by mbp at sourcefrog
import from baz patch-364
746
    def get_revision(self, revision_id):
747
        """Return the Revision object for a named revision"""
1182 by Martin Pool
- more disentangling of xml storage format from objects
748
        xml_file = self.get_revision_xml_file(revision_id)
1027 by Martin Pool
- better error message when failing to get revision from store
749
750
        try:
1189 by Martin Pool
- BROKEN: partial support for commit into weave
751
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
752
        except SyntaxError, e:
753
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
754
                                         [revision_id,
755
                                          str(e)])
802 by Martin Pool
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
756
            
1 by mbp at sourcefrog
import from baz patch-364
757
        assert r.revision_id == revision_id
758
        return r
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
759
760
    def get_revision_delta(self, revno):
761
        """Return the delta for one revision.
762
763
        The delta is relative to its mainline predecessor, or the
764
        empty tree for revision 1.
765
        """
766
        assert isinstance(revno, int)
767
        rh = self.revision_history()
768
        if not (1 <= revno <= len(rh)):
769
            raise InvalidRevisionNumber(revno)
770
771
        # revno is 1-based; list is 0-based
772
773
        new_tree = self.revision_tree(rh[revno-1])
774
        if revno == 1:
775
            old_tree = EmptyTree()
776
        else:
777
            old_tree = self.revision_tree(rh[revno-2])
778
779
        return compare_trees(old_tree, new_tree)
780
672 by Martin Pool
- revision records include the hash of their inventory and
781
    def get_revision_sha1(self, revision_id):
782
        """Hash the stored value of a revision, and return it."""
783
        # In the future, revision entries will be signed. At that
784
        # point, it is probably best *not* to include the signature
785
        # in the revision hash. Because that lets you re-sign
786
        # the revision, (add signatures/remove signatures) and still
787
        # have all hash pointers stay consistent.
788
        # But for now, just hash the contents.
1230 by Martin Pool
- remove Branch.get_revision_xml; use get_revision_xml_file instead
789
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
672 by Martin Pool
- revision records include the hash of their inventory and
790
1225 by Martin Pool
- branch now tracks ancestry - all merged revisions
791
    def get_ancestry(self, revision_id):
1415 by Robert Collins
remove the ancestry weave file
792
        """Return a list of revision-ids integrated by a revision.
793
        
794
        This currently returns a list, but the ordering is not guaranteed:
795
        treat it as a set.
796
        """
1390 by Robert Collins
pair programming worx... merge integration and weave
797
        if revision_id is None:
798
            return [None]
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
799
        w = self.get_inventory_weave()
1415 by Robert Collins
remove the ancestry weave file
800
        return [None] + map(w.idx_to_name,
801
                            w.inclusions([w.lookup(revision_id)]))
1225 by Martin Pool
- branch now tracks ancestry - all merged revisions
802
1223 by Martin Pool
- store inventories in weave
803
    def get_inventory_weave(self):
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
804
        return self.control_weaves.get_weave('inventory',
805
                                             self.get_transaction())
1223 by Martin Pool
- store inventories in weave
806
1192 by Martin Pool
- clean up code for retrieving stored inventories
807
    def get_inventory(self, revision_id):
1223 by Martin Pool
- store inventories in weave
808
        """Get Inventory object by hash."""
1372 by Martin Pool
- avoid converting inventories to/from StringIO
809
        xml = self.get_inventory_xml(revision_id)
810
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
811
1192 by Martin Pool
- clean up code for retrieving stored inventories
812
    def get_inventory_xml(self, revision_id):
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
813
        """Get inventory XML as a file object."""
1192 by Martin Pool
- clean up code for retrieving stored inventories
814
        try:
815
            assert isinstance(revision_id, basestring), type(revision_id)
1223 by Martin Pool
- store inventories in weave
816
            iw = self.get_inventory_weave()
817
            return iw.get_text(iw.lookup(revision_id))
1192 by Martin Pool
- clean up code for retrieving stored inventories
818
        except IndexError:
819
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
1180 by Martin Pool
- start splitting code for xml (de)serialization away from objects
820
1192 by Martin Pool
- clean up code for retrieving stored inventories
821
    def get_inventory_sha1(self, revision_id):
672 by Martin Pool
- revision records include the hash of their inventory and
822
        """Return the sha1 hash of the inventory entry
823
        """
1223 by Martin Pool
- store inventories in weave
824
        return self.get_revision(revision_id).inventory_sha1
672 by Martin Pool
- revision records include the hash of their inventory and
825
1 by mbp at sourcefrog
import from baz patch-364
826
    def get_revision_inventory(self, revision_id):
827
        """Return inventory of a past revision."""
1372 by Martin Pool
- avoid converting inventories to/from StringIO
828
        # TODO: Unify this with get_inventory()
1218 by Martin Pool
- fix up import
829
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
820 by Martin Pool
- faster Branch.get_revision_inventory now we know the ids are the same
830
        # must be the same as its revision, so this is trivial.
1 by mbp at sourcefrog
import from baz patch-364
831
        if revision_id == None:
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
832
            return Inventory(self.get_root_id())
1 by mbp at sourcefrog
import from baz patch-364
833
        else:
820 by Martin Pool
- faster Branch.get_revision_inventory now we know the ids are the same
834
            return self.get_inventory(revision_id)
1 by mbp at sourcefrog
import from baz patch-364
835
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
836
    @needs_read_lock
1 by mbp at sourcefrog
import from baz patch-364
837
    def revision_history(self):
1295 by Martin Pool
- remove pointless doctest
838
        """Return sequence of revision hashes on to this branch."""
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
839
        transaction = self.get_transaction()
840
        history = transaction.map.find_revision_history()
841
        if history is not None:
842
            mutter("cache hit for revision-history in %s", self)
1417.1.12 by Robert Collins
cache revision history during read transactions
843
            return list(history)
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
844
        history = [l.rstrip('\r\n') for l in
845
                self.controlfile('revision-history', 'r').readlines()]
846
        transaction.map.add_revision_history(history)
847
        # this call is disabled because revision_history is 
848
        # not really an object yet, and the transaction is for objects.
849
        # transaction.register_clean(history, precious=True)
850
        return list(history)
1 by mbp at sourcefrog
import from baz patch-364
851
852
    def revno(self):
853
        """Return current revision number for this branch.
854
855
        That is equivalent to the number of revisions committed to
856
        this branch.
857
        """
858
        return len(self.revision_history())
859
1241 by Martin Pool
- rename last_patch to last_revision
860
    def last_revision(self):
1 by mbp at sourcefrog
import from baz patch-364
861
        """Return last patch hash, or None if no history.
862
        """
863
        ph = self.revision_history()
864
        if ph:
865
            return ph[-1]
184 by mbp at sourcefrog
pychecker fixups
866
        else:
867
            return None
485 by Martin Pool
- move commit code into its own module
868
974.1.27 by aaron.bentley at utoronto
Initial greedy fetch work
869
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
1260 by Martin Pool
- some updates for fetch/update function
870
        """Return a list of new revisions that would perfectly fit.
871
        
628 by Martin Pool
- merge aaron's updated merge/pull code
872
        If self and other have not diverged, return a list of the revisions
873
        present in other, but missing from self.
874
875
        >>> from bzrlib.commit import commit
876
        >>> bzrlib.trace.silent = True
877
        >>> br1 = ScratchBranch()
878
        >>> br2 = ScratchBranch()
879
        >>> br1.missing_revisions(br2)
880
        []
881
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
882
        >>> br1.missing_revisions(br2)
883
        [u'REVISION-ID-1']
884
        >>> br2.missing_revisions(br1)
885
        []
886
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
887
        >>> br1.missing_revisions(br2)
888
        []
889
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
890
        >>> br1.missing_revisions(br2)
891
        [u'REVISION-ID-2A']
892
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
893
        >>> br1.missing_revisions(br2)
894
        Traceback (most recent call last):
895
        DivergedBranches: These branches have diverged.
896
        """
897
        self_history = self.revision_history()
898
        self_len = len(self_history)
899
        other_history = other.revision_history()
900
        other_len = len(other_history)
901
        common_index = min(self_len, other_len) -1
902
        if common_index >= 0 and \
903
            self_history[common_index] != other_history[common_index]:
904
            raise DivergedBranches(self, other)
685 by Martin Pool
- add -r option to the branch command
905
906
        if stop_revision is None:
907
            stop_revision = other_len
1273 by Martin Pool
- fix up copy_branch, etc
908
        else:
909
            assert isinstance(stop_revision, int)
910
            if stop_revision > other_len:
911
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
685 by Martin Pool
- add -r option to the branch command
912
        return other_history[self_len:stop_revision]
913
974.1.28 by aaron.bentley at utoronto
factored install_revisions out of update_revisions, updated test cases for greedy_fetch
914
    def update_revisions(self, other, stop_revision=None):
1390 by Robert Collins
pair programming worx... merge integration and weave
915
        """Pull in new perfect-fit revisions."""
1185.12.22 by aaron.bentley at utoronto
Moved fixme to more appropriate place
916
        # FIXME: If the branches have diverged, but the latest
917
        # revision in this branch is completely merged into the other,
918
        # then we should still be able to pull.
974.1.33 by aaron.bentley at utoronto
Added greedy_fetch to update_revisions
919
        from bzrlib.fetch import greedy_fetch
974.1.75 by Aaron Bentley
Sped up pull by copying locally first
920
        if stop_revision is None:
1390 by Robert Collins
pair programming worx... merge integration and weave
921
            stop_revision = other.last_revision()
1185.12.44 by abentley
Restored branch convergence to bzr pull
922
        ### Should this be checking is_ancestor instead of revision_history?
1441 by Robert Collins
tests passing is a good idea - move the branch open in cmd_branch to ensure this, and remove noise from the test suite
923
        if (stop_revision is not None and 
924
            stop_revision in self.revision_history()):
1440 by Robert Collins
further tuning of pull, do not do a local merge or fetch at all, if the remote branch is no newer than we are
925
            return
1260 by Martin Pool
- some updates for fetch/update function
926
        greedy_fetch(to_branch=self, from_branch=other,
1261 by Martin Pool
- new method Branch.has_revision
927
                     revision=stop_revision)
1185.12.44 by abentley
Restored branch convergence to bzr pull
928
        pullable_revs = self.pullable_revisions(other, stop_revision)
1185.12.45 by abentley
Cleanups for pull
929
        if len(pullable_revs) > 0:
1261 by Martin Pool
- new method Branch.has_revision
930
            self.append_revision(*pullable_revs)
1185.12.44 by abentley
Restored branch convergence to bzr pull
931
932
    def pullable_revisions(self, other, stop_revision):
933
        other_revno = other.revision_id_to_revno(stop_revision)
934
        try:
935
            return self.missing_revisions(other, other_revno)
936
        except DivergedBranches, e:
937
            try:
938
                pullable_revs = get_intervening_revisions(self.last_revision(),
939
                                                          stop_revision, self)
940
                assert self.last_revision() not in pullable_revs
941
                return pullable_revs
942
            except bzrlib.errors.NotAncestor:
943
                if is_ancestor(self.last_revision(), stop_revision, self):
944
                    return []
945
                else:
946
                    raise e
947
        
485 by Martin Pool
- move commit code into its own module
948
    def commit(self, *args, **kw):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
949
        from bzrlib.commit import Commit
950
        Commit().commit(self, *args, **kw)
1390 by Robert Collins
pair programming worx... merge integration and weave
951
    
1105 by Martin Pool
- expose 'find-merge-base' as a new expert command,
952
    def revision_id_to_revno(self, revision_id):
953
        """Given a revision id, return its revno"""
1390 by Robert Collins
pair programming worx... merge integration and weave
954
        if revision_id is None:
955
            return 0
1105 by Martin Pool
- expose 'find-merge-base' as a new expert command,
956
        history = self.revision_history()
957
        try:
958
            return history.index(revision_id) + 1
959
        except ValueError:
960
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
961
974.2.7 by aaron.bentley at utoronto
Merged from bzr.24
962
    def get_rev_id(self, revno, history=None):
963
        """Find the revision id of the specified revno."""
964
        if revno == 0:
965
            return None
966
        if history is None:
967
            history = self.revision_history()
968
        elif revno <= 0 or revno > len(history):
969
            raise bzrlib.errors.NoSuchRevision(self, revno)
970
        return history[revno - 1]
971
1 by mbp at sourcefrog
import from baz patch-364
972
    def revision_tree(self, revision_id):
973
        """Return Tree for a revision on this branch.
974
975
        `revision_id` may be None for the null revision, in which case
976
        an `EmptyTree` is returned."""
529 by Martin Pool
todo
977
        # TODO: refactor this to use an existing revision object
978
        # so we don't need to read it in twice.
1 by mbp at sourcefrog
import from baz patch-364
979
        if revision_id == None:
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
980
            return EmptyTree()
1 by mbp at sourcefrog
import from baz patch-364
981
        else:
982
            inv = self.get_revision_inventory(revision_id)
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
983
            return RevisionTree(self.weave_store, inv, revision_id)
1 by mbp at sourcefrog
import from baz patch-364
984
985
    def working_tree(self):
986
        """Return a `Tree` for the working copy."""
1185.2.2 by Lalo Martins
cleaning up and refactoring the branch module.
987
        from bzrlib.workingtree import WorkingTree
907.1.5 by John Arbash Meinel
Some more work, including ScratchBranch changes.
988
        # TODO: In the future, WorkingTree should utilize Transport
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
989
        # RobertCollins 20051003 - I don't think it should - working trees are
990
        # much more complex to keep consistent than our careful .bzr subset.
991
        # instead, we should say that working trees are local only, and optimise
992
        # for that.
1457.1.1 by Robert Collins
rather than getting the branch inventory, WorkingTree can use the whole Branch, or make its own.
993
        return WorkingTree(self.base, branch=self)
1 by mbp at sourcefrog
import from baz patch-364
994
995
996
    def basis_tree(self):
997
        """Return `Tree` object for last revision.
998
999
        If there are no revisions yet, return an `EmptyTree`.
1000
        """
1241 by Martin Pool
- rename last_patch to last_revision
1001
        return self.revision_tree(self.last_revision())
1 by mbp at sourcefrog
import from baz patch-364
1002
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1003
    @needs_write_lock
168 by mbp at sourcefrog
new "rename" command
1004
    def rename_one(self, from_rel, to_rel):
309 by Martin Pool
doc
1005
        """Rename one file.
1006
1007
        This can change the directory or the filename or both.
353 by Martin Pool
- Per-branch locks in read and write modes.
1008
        """
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1009
        tree = self.working_tree()
1010
        inv = tree.inventory
1011
        if not tree.has_filename(from_rel):
1012
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1013
        if tree.has_filename(to_rel):
1014
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
1015
1016
        file_id = inv.path2id(from_rel)
1017
        if file_id == None:
1018
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1019
1020
        if inv.path2id(to_rel):
1021
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1022
1023
        to_dir, to_tail = os.path.split(to_rel)
1024
        to_dir_id = inv.path2id(to_dir)
1025
        if to_dir_id == None and to_dir != '':
1026
            raise BzrError("can't determine destination directory id for %r" % to_dir)
1027
1028
        mutter("rename_one:")
1029
        mutter("  file_id    {%s}" % file_id)
1030
        mutter("  from_rel   %r" % from_rel)
1031
        mutter("  to_rel     %r" % to_rel)
1032
        mutter("  to_dir     %r" % to_dir)
1033
        mutter("  to_dir_id  {%s}" % to_dir_id)
1034
1035
        inv.rename(file_id, to_dir_id, to_tail)
1036
1037
        from_abs = self.abspath(from_rel)
1038
        to_abs = self.abspath(to_rel)
171 by mbp at sourcefrog
better error message when working file rename fails
1039
        try:
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1040
            rename(from_abs, to_abs)
1041
        except OSError, e:
1042
            raise BzrError("failed to rename %r to %r: %s"
1043
                    % (from_abs, to_abs, e[1]),
1044
                    ["rename rolled back"])
1045
1046
        self._write_inventory(inv)
1047
1048
    @needs_write_lock
174 by mbp at sourcefrog
- New 'move' command; now separated out from rename
1049
    def move(self, from_paths, to_name):
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1050
        """Rename files.
1051
174 by mbp at sourcefrog
- New 'move' command; now separated out from rename
1052
        to_name must exist as a versioned directory.
1053
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1054
        If to_name exists and is a directory, the files are moved into
1055
        it, keeping their old names.  If it is a directory, 
1056
1057
        Note that to_name is only the last component of the new name;
1058
        this doesn't change the directory.
1131 by Martin Pool
- remove more extraneous print statements from Branch.move
1059
1060
        This returns a list of (from_path, to_path) pairs for each
1061
        entry that is moved.
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1062
        """
1131 by Martin Pool
- remove more extraneous print statements from Branch.move
1063
        result = []
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1064
        ## TODO: Option to move IDs only
1065
        assert not isinstance(from_paths, basestring)
1066
        tree = self.working_tree()
1067
        inv = tree.inventory
1068
        to_abs = self.abspath(to_name)
1069
        if not isdir(to_abs):
1070
            raise BzrError("destination %r is not a directory" % to_abs)
1071
        if not tree.has_filename(to_name):
1072
            raise BzrError("destination %r not in working directory" % to_abs)
1073
        to_dir_id = inv.path2id(to_name)
1074
        if to_dir_id == None and to_name != '':
1075
            raise BzrError("destination %r is not a versioned directory" % to_name)
1076
        to_dir_ie = inv[to_dir_id]
1077
        if to_dir_ie.kind not in ('directory', 'root_directory'):
1078
            raise BzrError("destination %r is not a directory" % to_abs)
1079
1080
        to_idpath = inv.get_idpath(to_dir_id)
1081
1082
        for f in from_paths:
1083
            if not tree.has_filename(f):
1084
                raise BzrError("%r does not exist in working tree" % f)
1085
            f_id = inv.path2id(f)
1086
            if f_id == None:
1087
                raise BzrError("%r is not versioned" % f)
1088
            name_tail = splitpath(f)[-1]
1089
            dest_path = appendpath(to_name, name_tail)
1090
            if tree.has_filename(dest_path):
1091
                raise BzrError("destination %r already exists" % dest_path)
1092
            if f_id in to_idpath:
1093
                raise BzrError("can't move %r to a subdirectory of itself" % f)
1094
1095
        # OK, so there's a race here, it's possible that someone will
1096
        # create a file in this interval and then the rename might be
1097
        # left half-done.  But we should have caught most problems.
1098
1099
        for f in from_paths:
1100
            name_tail = splitpath(f)[-1]
1101
            dest_path = appendpath(to_name, name_tail)
1102
            result.append((f, dest_path))
1103
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
1104
            try:
1105
                rename(self.abspath(f), self.abspath(dest_path))
1106
            except OSError, e:
1107
                raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1108
                        ["rename rolled back"])
1109
1110
        self._write_inventory(inv)
1131 by Martin Pool
- remove more extraneous print statements from Branch.move
1111
        return result
1112
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1113
782 by Martin Pool
- Branch.revert copies files to backups before reverting them
1114
    def revert(self, filenames, old_tree=None, backups=True):
778 by Martin Pool
- simple revert of text files
1115
        """Restore selected files to the versions from a previous tree.
782 by Martin Pool
- Branch.revert copies files to backups before reverting them
1116
1117
        backups
1118
            If true (default) backups are made of files before
1119
            they're renamed.
778 by Martin Pool
- simple revert of text files
1120
        """
1121
        from bzrlib.errors import NotVersionedError, BzrError
1122
        from bzrlib.atomicfile import AtomicFile
782 by Martin Pool
- Branch.revert copies files to backups before reverting them
1123
        from bzrlib.osutils import backup_file
778 by Martin Pool
- simple revert of text files
1124
        
1125
        inv = self.read_working_inventory()
1126
        if old_tree is None:
1127
            old_tree = self.basis_tree()
1128
        old_inv = old_tree.inventory
1129
1130
        nids = []
1131
        for fn in filenames:
1132
            file_id = inv.path2id(fn)
1133
            if not file_id:
1134
                raise NotVersionedError("not a versioned file", fn)
782 by Martin Pool
- Branch.revert copies files to backups before reverting them
1135
            if not old_inv.has_id(file_id):
1136
                raise BzrError("file not present in old tree", fn, file_id)
778 by Martin Pool
- simple revert of text files
1137
            nids.append((fn, file_id))
1138
            
1139
        # TODO: Rename back if it was previously at a different location
1140
1141
        # TODO: If given a directory, restore the entire contents from
1142
        # the previous version.
1143
1144
        # TODO: Make a backup to a temporary file.
1145
1146
        # TODO: If the file previously didn't exist, delete it?
1147
        for fn, file_id in nids:
782 by Martin Pool
- Branch.revert copies files to backups before reverting them
1148
            backup_file(fn)
1149
            
778 by Martin Pool
- simple revert of text files
1150
            f = AtomicFile(fn, 'wb')
1151
            try:
1152
                f.write(old_tree.get_file(file_id).read())
1153
                f.commit()
1154
            finally:
1155
                f.close()
1156
1157
815 by Martin Pool
- track pending-merges
1158
    def pending_merges(self):
1159
        """Return a list of pending merges.
1160
1161
        These are revisions that have been merged into the working
1162
        directory but not yet committed.
1163
        """
907.1.2 by John Arbash Meinel
Working on making Branch() do all of it's work over a Transport.
1164
        cfn = self._rel_controlfilename('pending-merges')
907.1.8 by John Arbash Meinel
Changed the format for abspath. Updated branch to use a hidden _transport
1165
        if not self._transport.has(cfn):
815 by Martin Pool
- track pending-merges
1166
            return []
1167
        p = []
1168
        for l in self.controlfile('pending-merges', 'r').readlines():
1169
            p.append(l.rstrip('\n'))
1170
        return p
1171
1172
907.1.4 by John Arbash Meinel
Add pending_merge can take multiple entries.
1173
    def add_pending_merge(self, *revision_ids):
1263 by Martin Pool
- clean up imports
1174
        # TODO: Perhaps should check at this point that the
1175
        # history of the revision is actually present?
815 by Martin Pool
- track pending-merges
1176
        p = self.pending_merges()
907.1.4 by John Arbash Meinel
Add pending_merge can take multiple entries.
1177
        updated = False
1178
        for rev_id in revision_ids:
1179
            if rev_id in p:
1180
                continue
1181
            p.append(rev_id)
1182
            updated = True
1183
        if updated:
1184
            self.set_pending_merges(p)
815 by Martin Pool
- track pending-merges
1185
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1186
    @needs_write_lock
815 by Martin Pool
- track pending-merges
1187
    def set_pending_merges(self, rev_list):
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1188
        self.put_controlfile('pending-merges', '\n'.join(rev_list))
815 by Martin Pool
- track pending-merges
1189
1149 by Martin Pool
- make get_parent() be a method of Branch; add simple tests for it
1190
    def get_parent(self):
1191
        """Return the parent location of the branch.
1192
1193
        This is the default location for push/pull/missing.  The usual
1194
        pattern is that the user can override it by specifying a
1195
        location.
1196
        """
1197
        import errno
1198
        _locs = ['parent', 'pull', 'x-pull']
1199
        for l in _locs:
1200
            try:
1201
                return self.controlfile(l, 'r').read().strip('\n')
1202
            except IOError, e:
1203
                if e.errno != errno.ENOENT:
1204
                    raise
1205
        return None
1206
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1207
    @needs_write_lock
1150 by Martin Pool
- add new Branch.set_parent and tests
1208
    def set_parent(self, url):
1209
        # TODO: Maybe delete old location files?
1210
        from bzrlib.atomicfile import AtomicFile
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1211
        f = AtomicFile(self.controlfilename('parent'))
1150 by Martin Pool
- add new Branch.set_parent and tests
1212
        try:
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1213
            f.write(url + '\n')
1214
            f.commit()
1150 by Martin Pool
- add new Branch.set_parent and tests
1215
        finally:
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1216
            f.close()
1150 by Martin Pool
- add new Branch.set_parent and tests
1217
974.1.54 by aaron.bentley at utoronto
Fixed the revno bug in log
1218
    def check_revno(self, revno):
1219
        """\
1220
        Check whether a revno corresponds to any revision.
1221
        Zero (the NULL revision) is considered valid.
1222
        """
1223
        if revno != 0:
1224
            self.check_real_revno(revno)
1225
            
1226
    def check_real_revno(self, revno):
1227
        """\
1228
        Check whether a revno corresponds to a real revision.
1229
        Zero (the NULL revision) is considered invalid
1230
        """
1231
        if revno < 1 or revno > self.revno():
1232
            raise InvalidRevisionNumber(revno)
1233
        
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
1234
    def sign_revision(self, revision_id, gpg_strategy):
1442.1.62 by Robert Collins
Allow creation of testaments from uncommitted data, and use that to get signatures before committing revisions.
1235
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
1236
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1237
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1238
    @needs_write_lock
1442.1.62 by Robert Collins
Allow creation of testaments from uncommitted data, and use that to get signatures before committing revisions.
1239
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1442.1.63 by Robert Collins
Remove self.lock_*...finally: self.unlock() dead chickens from branch.py.
1240
        self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)), 
1241
                                revision_id, "sig")
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
1242
1243
1185.11.11 by John Arbash Meinel
Removing the remotebranch object.
1244
class ScratchBranch(_Branch):
1 by mbp at sourcefrog
import from baz patch-364
1245
    """Special test class: a branch that cleans up after itself.
1246
1247
    >>> b = ScratchBranch()
1248
    >>> isdir(b.base)
1249
    True
1250
    >>> bd = b.base
1442.1.42 by Robert Collins
rebuild ScratchBranch on top of ScratchTransport
1251
    >>> b._transport.__del__()
1 by mbp at sourcefrog
import from baz patch-364
1252
    >>> isdir(bd)
1253
    False
1254
    """
1442.1.42 by Robert Collins
rebuild ScratchBranch on top of ScratchTransport
1255
1256
    def __init__(self, files=[], dirs=[], transport=None):
1 by mbp at sourcefrog
import from baz patch-364
1257
        """Make a test branch.
1258
1259
        This creates a temporary directory and runs init-tree in it.
1260
1261
        If any files are listed, they are created in the working copy.
1262
        """
1442.1.42 by Robert Collins
rebuild ScratchBranch on top of ScratchTransport
1263
        if transport is None:
1264
            transport = bzrlib.transport.local.ScratchTransport()
1265
            super(ScratchBranch, self).__init__(transport, init=True)
1266
        else:
1267
            super(ScratchBranch, self).__init__(transport)
1268
100 by mbp at sourcefrog
- add test case for ignore files
1269
        for d in dirs:
907.1.8 by John Arbash Meinel
Changed the format for abspath. Updated branch to use a hidden _transport
1270
            self._transport.mkdir(d)
100 by mbp at sourcefrog
- add test case for ignore files
1271
            
1 by mbp at sourcefrog
import from baz patch-364
1272
        for f in files:
907.1.8 by John Arbash Meinel
Changed the format for abspath. Updated branch to use a hidden _transport
1273
            self._transport.put(f, 'content of %s' % f)
1 by mbp at sourcefrog
import from baz patch-364
1274
1275
622 by Martin Pool
Updated merge patch from Aaron
1276
    def clone(self):
1277
        """
1278
        >>> orig = ScratchBranch(files=["file1", "file2"])
1279
        >>> clone = orig.clone()
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
1280
        >>> if os.name != 'nt':
1281
        ...   os.path.samefile(orig.base, clone.base)
1282
        ... else:
1283
        ...   orig.base == clone.base
1284
        ...
622 by Martin Pool
Updated merge patch from Aaron
1285
        False
1286
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1287
        True
1288
        """
800 by Martin Pool
Merge John's import-speedup branch:
1289
        from shutil import copytree
1290
        from tempfile import mkdtemp
1291
        base = mkdtemp()
622 by Martin Pool
Updated merge patch from Aaron
1292
        os.rmdir(base)
800 by Martin Pool
Merge John's import-speedup branch:
1293
        copytree(self.base, base, symlinks=True)
1442.1.42 by Robert Collins
rebuild ScratchBranch on top of ScratchTransport
1294
        return ScratchBranch(
1295
            transport=bzrlib.transport.local.ScratchTransport(base))
1 by mbp at sourcefrog
import from baz patch-364
1296
    
1297
1298
######################################################################
1299
# predicates
1300
1301
1302
def is_control_file(filename):
1303
    ## FIXME: better check
1304
    filename = os.path.normpath(filename)
1305
    while filename != '':
1306
        head, tail = os.path.split(filename)
1307
        ## mutter('check %r for control file' % ((head, tail), ))
1308
        if tail == bzrlib.BZRDIR:
1309
            return True
70 by mbp at sourcefrog
Prepare for smart recursive add.
1310
        if filename == head:
1311
            break
1 by mbp at sourcefrog
import from baz patch-364
1312
        filename = head
1313
    return False
1314
1315
1316
70 by mbp at sourcefrog
Prepare for smart recursive add.
1317
def gen_file_id(name):
1 by mbp at sourcefrog
import from baz patch-364
1318
    """Return new file id.
1319
1320
    This should probably generate proper UUIDs, but for the moment we
1321
    cope with just randomness because running uuidgen every time is
1322
    slow."""
535 by Martin Pool
- try to eliminate wierd characters from file names when they're
1323
    import re
800 by Martin Pool
Merge John's import-speedup branch:
1324
    from binascii import hexlify
1325
    from time import time
535 by Martin Pool
- try to eliminate wierd characters from file names when they're
1326
1327
    # get last component
70 by mbp at sourcefrog
Prepare for smart recursive add.
1328
    idx = name.rfind('/')
1329
    if idx != -1:
1330
        name = name[idx+1 : ]
262 by Martin Pool
- gen_file_id: break the file on either / or \ when looking
1331
    idx = name.rfind('\\')
1332
    if idx != -1:
1333
        name = name[idx+1 : ]
70 by mbp at sourcefrog
Prepare for smart recursive add.
1334
535 by Martin Pool
- try to eliminate wierd characters from file names when they're
1335
    # make it not a hidden file
70 by mbp at sourcefrog
Prepare for smart recursive add.
1336
    name = name.lstrip('.')
1337
535 by Martin Pool
- try to eliminate wierd characters from file names when they're
1338
    # remove any wierd characters; we don't escape them but rather
1339
    # just pull them out
1340
    name = re.sub(r'[^\w.]', '', name)
1341
190 by mbp at sourcefrog
64 bits of randomness in file/revision ids
1342
    s = hexlify(rand_bytes(8))
800 by Martin Pool
Merge John's import-speedup branch:
1343
    return '-'.join((name, compact_date(time()), s))
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
1344
1345
1346
def gen_root_id():
1347
    """Return a new tree-root file id."""
1348
    return gen_file_id('TREE_ROOT')
1349
1092.1.34 by Robert Collins
unbreak cmd_branch now that something tests the core of it..
1350