← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

Tags: bzr-0.1
- testament symlink support

- more testament tests

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