← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-10-06 06:31:16 UTC
  • mto: (1185.13.3)
  • mto: This revision was merged to the branch mainline in revision 1417.
  • Revision ID: mbp@sourcefrog.net-20051006063116-c5f754d95cbba812
- put 'format=5' on inventory and revision xml

  suggestion from john

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