← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2005-10-29 23:48:45 UTC
  • Revision ID: robertc@robertcollins.net-20051029234845-7ae4e7d118bdd3ed
Implement a 'bzr push' command, with saved locations; update diff to return 1.

    * 'bzr diff' now returns 1 when there are changes in the working 
      tree.

    * 'bzr push' now exists and can push changes to a remote location. 
      This uses the transport infrastructure, and can store the remote
      location in the ~/.bazaar/branches.conf configuration file.

    * WorkingTree.pull has been split across Branch and WorkingTree,
      to allow Branch only pulls.

    * commands.display_command now returns the result of the decorated 
      function.

    * LocationConfig now has a set_user_option(key, value) call to save
      a setting in its matching location section (a new one is created
      if needed).

    * Branch has two new methods, get_push_location and set_push_location
      to respectively, get and set the push location.

Show diffs side-by-side

added added

removed removed

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