/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2005-10-06 06:31:33 UTC
  • Revision ID: robertc@robertcollins.net-20051006063133-5e9bf4c7570cae6c
remove the ancestry weave file

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
import sys
 
19
import os
 
20
import errno
 
21
from warnings import warn
 
22
from cStringIO import StringIO
 
23
 
 
24
 
 
25
import bzrlib
 
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
 
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"
 
52
## TODO: Maybe include checks for common corruption of newlines, etc?
 
53
 
 
54
 
 
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
 
110
 
 
111
 
 
112
######################################################################
 
113
# branch objects
 
114
 
 
115
class Branch(object):
 
116
    """Branch holding a history of revisions.
 
117
 
 
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):
 
215
        """Create new branch object at a particular location.
 
216
 
 
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
 
222
             unversioned directory.  If False, the branch must already
 
223
             be versioned.
 
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
 
 
230
        In the test suite, creation of new trees is tested using the
 
231
        `ScratchBranch` class.
 
232
        """
 
233
        assert isinstance(transport, Transport), \
 
234
            "%r is not a Transport" % transport
 
235
        self._transport = transport
 
236
        if init:
 
237
            self._make_control()
 
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)
 
270
 
 
271
    def __str__(self):
 
272
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
 
273
 
 
274
 
 
275
    __repr__ = __str__
 
276
 
 
277
 
 
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
 
359
 
 
360
    def controlfilename(self, file_or_path):
 
361
        """Return location relative to branch."""
 
362
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
 
363
 
 
364
 
 
365
    def controlfile(self, file_or_path, mode='r'):
 
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)
 
420
 
 
421
    def _make_control(self):
 
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', 
 
439
            "This is a Bazaar-NG control directory.\n"
 
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):
 
456
        """Check this branch format is supported.
 
457
 
 
458
        The format level is stored, as an integer, in
 
459
        self._branch_format for code that needs to check it later.
 
460
 
 
461
        In the future, we might need different in-memory Branch
 
462
        classes to support downlevel branches.  But not yet.
 
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)
 
497
 
 
498
    def read_working_inventory(self):
 
499
        """Read the working inventory."""
 
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
            
 
509
 
 
510
    def _write_inventory(self, inv):
 
511
        """Update the working inventory.
 
512
 
 
513
        That is to say, the inventory describing changes underway, that
 
514
        will be committed to the next revision.
 
515
        """
 
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
        
 
527
        mutter('wrote working inventory')
 
528
            
 
529
    inventory = property(read_working_inventory, _write_inventory, None,
 
530
                         """Inventory for the working copy.""")
 
531
 
 
532
    def add(self, files, ids=None):
 
533
        """Make files versioned.
 
534
 
 
535
        Note that the command line normally calls smart_add instead,
 
536
        which can automatically recurse.
 
537
 
 
538
        This puts the files in the Added state, so that they will be
 
539
        recorded by the next commit.
 
540
 
 
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.
 
553
        """
 
554
        # TODO: Re-adding a file that is removed in the working copy
 
555
        # should probably put it back with the previous ID.
 
556
        if isinstance(files, basestring):
 
557
            assert(ids is None or isinstance(ids, basestring))
 
558
            files = [files]
 
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()
 
614
 
 
615
 
 
616
    def remove(self, files, verbose=False):
 
617
        """Mark nominated files for removal from the inventory.
 
618
 
 
619
        This does not remove their text.  This does not run on 
 
620
 
 
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
 
626
        removing may be useful and the user can just use use rm, and
 
627
        is the opposite of add.  Removing it is consistent with most
 
628
        other tools.  Maybe an option.
 
629
        """
 
630
        ## TODO: Normalize names
 
631
        ## TODO: Remove nested loops; better scalability
 
632
        if isinstance(files, basestring):
 
633
            files = [files]
 
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)
 
677
        self._write_inventory(inv)
 
678
 
 
679
    def unknowns(self):
 
680
        """Return all unknown files.
 
681
 
 
682
        These are files in the working directory that are not versioned or
 
683
        control files or ignored.
 
684
        
 
685
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
686
        >>> list(b.unknowns())
 
687
        ['foo']
 
688
        >>> b.add('foo')
 
689
        >>> list(b.unknowns())
 
690
        []
 
691
        >>> b.remove('foo')
 
692
        >>> list(b.unknowns())
 
693
        ['foo']
 
694
        """
 
695
        return self.working_tree().unknowns()
 
696
 
 
697
 
 
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()
 
736
 
 
737
 
 
738
    def get_revision(self, revision_id):
 
739
        """Return the Revision object for a named revision"""
 
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
            
 
749
        assert r.revision_id == revision_id
 
750
        return r
 
751
 
 
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(self, revision_id):
 
784
        """Return a list of revision-ids integrated by a revision.
 
785
        
 
786
        This currently returns a list, but the ordering is not guaranteed:
 
787
        treat it as a set.
 
788
        """
 
789
        if revision_id is None:
 
790
            return [None]
 
791
        w = self.control_weaves.get_weave('inventory')
 
792
        return [None] + map(w.idx_to_name,
 
793
                            w.inclusions([w.lookup(revision_id)]))
 
794
 
 
795
    def get_inventory_weave(self):
 
796
        return self.control_weaves.get_weave('inventory')
 
797
 
 
798
    def get_inventory(self, revision_id):
 
799
        """Get Inventory object by hash."""
 
800
        xml = self.get_inventory_xml(revision_id)
 
801
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
802
 
 
803
    def get_inventory_xml(self, revision_id):
 
804
        """Get inventory XML as a file object."""
 
805
        try:
 
806
            assert isinstance(revision_id, basestring), type(revision_id)
 
807
            iw = self.get_inventory_weave()
 
808
            return iw.get_text(iw.lookup(revision_id))
 
809
        except IndexError:
 
810
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
811
 
 
812
    def get_inventory_sha1(self, revision_id):
 
813
        """Return the sha1 hash of the inventory entry
 
814
        """
 
815
        return self.get_revision(revision_id).inventory_sha1
 
816
 
 
817
    def get_revision_inventory(self, revision_id):
 
818
        """Return inventory of a past revision."""
 
819
        # TODO: Unify this with get_inventory()
 
820
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
821
        # must be the same as its revision, so this is trivial.
 
822
        if revision_id == None:
 
823
            return Inventory(self.get_root_id())
 
824
        else:
 
825
            return self.get_inventory(revision_id)
 
826
 
 
827
    def revision_history(self):
 
828
        """Return sequence of revision hashes on to this branch."""
 
829
        self.lock_read()
 
830
        try:
 
831
            return [l.rstrip('\r\n') for l in
 
832
                    self.controlfile('revision-history', 'r').readlines()]
 
833
        finally:
 
834
            self.unlock()
 
835
 
 
836
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
837
        """
 
838
        >>> from bzrlib.commit import commit
 
839
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
840
        >>> sb.common_ancestor(sb) == (None, None)
 
841
        True
 
842
        >>> commit(sb, "Committing first revision", verbose=False)
 
843
        >>> sb.common_ancestor(sb)[0]
 
844
        1
 
845
        >>> clone = sb.clone()
 
846
        >>> commit(sb, "Committing second revision", verbose=False)
 
847
        >>> sb.common_ancestor(sb)[0]
 
848
        2
 
849
        >>> sb.common_ancestor(clone)[0]
 
850
        1
 
851
        >>> commit(clone, "Committing divergent second revision", 
 
852
        ...               verbose=False)
 
853
        >>> sb.common_ancestor(clone)[0]
 
854
        1
 
855
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
856
        True
 
857
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
858
        True
 
859
        >>> clone2 = sb.clone()
 
860
        >>> sb.common_ancestor(clone2)[0]
 
861
        2
 
862
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
863
        1
 
864
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
865
        1
 
866
        """
 
867
        my_history = self.revision_history()
 
868
        other_history = other.revision_history()
 
869
        if self_revno is None:
 
870
            self_revno = len(my_history)
 
871
        if other_revno is None:
 
872
            other_revno = len(other_history)
 
873
        indices = range(min((self_revno, other_revno)))
 
874
        indices.reverse()
 
875
        for r in indices:
 
876
            if my_history[r] == other_history[r]:
 
877
                return r+1, my_history[r]
 
878
        return None, None
 
879
 
 
880
 
 
881
    def revno(self):
 
882
        """Return current revision number for this branch.
 
883
 
 
884
        That is equivalent to the number of revisions committed to
 
885
        this branch.
 
886
        """
 
887
        return len(self.revision_history())
 
888
 
 
889
 
 
890
    def last_revision(self):
 
891
        """Return last patch hash, or None if no history.
 
892
        """
 
893
        ph = self.revision_history()
 
894
        if ph:
 
895
            return ph[-1]
 
896
        else:
 
897
            return None
 
898
 
 
899
 
 
900
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
901
        """Return a list of new revisions that would perfectly fit.
 
902
        
 
903
        If self and other have not diverged, return a list of the revisions
 
904
        present in other, but missing from self.
 
905
 
 
906
        >>> from bzrlib.commit import commit
 
907
        >>> bzrlib.trace.silent = True
 
908
        >>> br1 = ScratchBranch()
 
909
        >>> br2 = ScratchBranch()
 
910
        >>> br1.missing_revisions(br2)
 
911
        []
 
912
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
913
        >>> br1.missing_revisions(br2)
 
914
        [u'REVISION-ID-1']
 
915
        >>> br2.missing_revisions(br1)
 
916
        []
 
917
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
918
        >>> br1.missing_revisions(br2)
 
919
        []
 
920
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
921
        >>> br1.missing_revisions(br2)
 
922
        [u'REVISION-ID-2A']
 
923
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
924
        >>> br1.missing_revisions(br2)
 
925
        Traceback (most recent call last):
 
926
        DivergedBranches: These branches have diverged.
 
927
        """
 
928
        # FIXME: If the branches have diverged, but the latest
 
929
        # revision in this branch is completely merged into the other,
 
930
        # then we should still be able to pull.
 
931
        self_history = self.revision_history()
 
932
        self_len = len(self_history)
 
933
        other_history = other.revision_history()
 
934
        other_len = len(other_history)
 
935
        common_index = min(self_len, other_len) -1
 
936
        if common_index >= 0 and \
 
937
            self_history[common_index] != other_history[common_index]:
 
938
            raise DivergedBranches(self, other)
 
939
 
 
940
        if stop_revision is None:
 
941
            stop_revision = other_len
 
942
        else:
 
943
            assert isinstance(stop_revision, int)
 
944
            if stop_revision > other_len:
 
945
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
946
        return other_history[self_len:stop_revision]
 
947
 
 
948
    def update_revisions(self, other, stop_revision=None):
 
949
        """Pull in new perfect-fit revisions."""
 
950
        from bzrlib.fetch import greedy_fetch
 
951
        from bzrlib.revision import get_intervening_revisions
 
952
        if stop_revision is None:
 
953
            stop_revision = other.last_revision()
 
954
        greedy_fetch(to_branch=self, from_branch=other,
 
955
                     revision=stop_revision)
 
956
        pullable_revs = self.missing_revisions(
 
957
            other, other.revision_id_to_revno(stop_revision))
 
958
        if pullable_revs:
 
959
            greedy_fetch(to_branch=self,
 
960
                         from_branch=other,
 
961
                         revision=pullable_revs[-1])
 
962
            self.append_revision(*pullable_revs)
 
963
    
 
964
 
 
965
    def commit(self, *args, **kw):
 
966
        from bzrlib.commit import Commit
 
967
        Commit().commit(self, *args, **kw)
 
968
    
 
969
    def revision_id_to_revno(self, revision_id):
 
970
        """Given a revision id, return its revno"""
 
971
        if revision_id is None:
 
972
            return 0
 
973
        history = self.revision_history()
 
974
        try:
 
975
            return history.index(revision_id) + 1
 
976
        except ValueError:
 
977
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
978
 
 
979
    def get_rev_id(self, revno, history=None):
 
980
        """Find the revision id of the specified revno."""
 
981
        if revno == 0:
 
982
            return None
 
983
        if history is None:
 
984
            history = self.revision_history()
 
985
        elif revno <= 0 or revno > len(history):
 
986
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
987
        return history[revno - 1]
 
988
 
 
989
    def revision_tree(self, revision_id):
 
990
        """Return Tree for a revision on this branch.
 
991
 
 
992
        `revision_id` may be None for the null revision, in which case
 
993
        an `EmptyTree` is returned."""
 
994
        # TODO: refactor this to use an existing revision object
 
995
        # so we don't need to read it in twice.
 
996
        if revision_id == None:
 
997
            return EmptyTree()
 
998
        else:
 
999
            inv = self.get_revision_inventory(revision_id)
 
1000
            return RevisionTree(self.weave_store, inv, revision_id)
 
1001
 
 
1002
 
 
1003
    def working_tree(self):
 
1004
        """Return a `Tree` for the working copy."""
 
1005
        from bzrlib.workingtree import WorkingTree
 
1006
        # TODO: In the future, WorkingTree should utilize Transport
 
1007
        # RobertCollins 20051003 - I don't think it should - working trees are
 
1008
        # much more complex to keep consistent than our careful .bzr subset.
 
1009
        # instead, we should say that working trees are local only, and optimise
 
1010
        # for that.
 
1011
        return WorkingTree(self._transport.base, self.read_working_inventory())
 
1012
 
 
1013
 
 
1014
    def basis_tree(self):
 
1015
        """Return `Tree` object for last revision.
 
1016
 
 
1017
        If there are no revisions yet, return an `EmptyTree`.
 
1018
        """
 
1019
        return self.revision_tree(self.last_revision())
 
1020
 
 
1021
 
 
1022
    def rename_one(self, from_rel, to_rel):
 
1023
        """Rename one file.
 
1024
 
 
1025
        This can change the directory or the filename or both.
 
1026
        """
 
1027
        self.lock_write()
 
1028
        try:
 
1029
            tree = self.working_tree()
 
1030
            inv = tree.inventory
 
1031
            if not tree.has_filename(from_rel):
 
1032
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1033
            if tree.has_filename(to_rel):
 
1034
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1035
 
 
1036
            file_id = inv.path2id(from_rel)
 
1037
            if file_id == None:
 
1038
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1039
 
 
1040
            if inv.path2id(to_rel):
 
1041
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1042
 
 
1043
            to_dir, to_tail = os.path.split(to_rel)
 
1044
            to_dir_id = inv.path2id(to_dir)
 
1045
            if to_dir_id == None and to_dir != '':
 
1046
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1047
 
 
1048
            mutter("rename_one:")
 
1049
            mutter("  file_id    {%s}" % file_id)
 
1050
            mutter("  from_rel   %r" % from_rel)
 
1051
            mutter("  to_rel     %r" % to_rel)
 
1052
            mutter("  to_dir     %r" % to_dir)
 
1053
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1054
 
 
1055
            inv.rename(file_id, to_dir_id, to_tail)
 
1056
 
 
1057
            from_abs = self.abspath(from_rel)
 
1058
            to_abs = self.abspath(to_rel)
 
1059
            try:
 
1060
                rename(from_abs, to_abs)
 
1061
            except OSError, e:
 
1062
                raise BzrError("failed to rename %r to %r: %s"
 
1063
                        % (from_abs, to_abs, e[1]),
 
1064
                        ["rename rolled back"])
 
1065
 
 
1066
            self._write_inventory(inv)
 
1067
        finally:
 
1068
            self.unlock()
 
1069
 
 
1070
 
 
1071
    def move(self, from_paths, to_name):
 
1072
        """Rename files.
 
1073
 
 
1074
        to_name must exist as a versioned directory.
 
1075
 
 
1076
        If to_name exists and is a directory, the files are moved into
 
1077
        it, keeping their old names.  If it is a directory, 
 
1078
 
 
1079
        Note that to_name is only the last component of the new name;
 
1080
        this doesn't change the directory.
 
1081
 
 
1082
        This returns a list of (from_path, to_path) pairs for each
 
1083
        entry that is moved.
 
1084
        """
 
1085
        result = []
 
1086
        self.lock_write()
 
1087
        try:
 
1088
            ## TODO: Option to move IDs only
 
1089
            assert not isinstance(from_paths, basestring)
 
1090
            tree = self.working_tree()
 
1091
            inv = tree.inventory
 
1092
            to_abs = self.abspath(to_name)
 
1093
            if not isdir(to_abs):
 
1094
                raise BzrError("destination %r is not a directory" % to_abs)
 
1095
            if not tree.has_filename(to_name):
 
1096
                raise BzrError("destination %r not in working directory" % to_abs)
 
1097
            to_dir_id = inv.path2id(to_name)
 
1098
            if to_dir_id == None and to_name != '':
 
1099
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1100
            to_dir_ie = inv[to_dir_id]
 
1101
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1102
                raise BzrError("destination %r is not a directory" % to_abs)
 
1103
 
 
1104
            to_idpath = inv.get_idpath(to_dir_id)
 
1105
 
 
1106
            for f in from_paths:
 
1107
                if not tree.has_filename(f):
 
1108
                    raise BzrError("%r does not exist in working tree" % f)
 
1109
                f_id = inv.path2id(f)
 
1110
                if f_id == None:
 
1111
                    raise BzrError("%r is not versioned" % f)
 
1112
                name_tail = splitpath(f)[-1]
 
1113
                dest_path = appendpath(to_name, name_tail)
 
1114
                if tree.has_filename(dest_path):
 
1115
                    raise BzrError("destination %r already exists" % dest_path)
 
1116
                if f_id in to_idpath:
 
1117
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1118
 
 
1119
            # OK, so there's a race here, it's possible that someone will
 
1120
            # create a file in this interval and then the rename might be
 
1121
            # left half-done.  But we should have caught most problems.
 
1122
 
 
1123
            for f in from_paths:
 
1124
                name_tail = splitpath(f)[-1]
 
1125
                dest_path = appendpath(to_name, name_tail)
 
1126
                result.append((f, dest_path))
 
1127
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1128
                try:
 
1129
                    rename(self.abspath(f), self.abspath(dest_path))
 
1130
                except OSError, e:
 
1131
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1132
                            ["rename rolled back"])
 
1133
 
 
1134
            self._write_inventory(inv)
 
1135
        finally:
 
1136
            self.unlock()
 
1137
 
 
1138
        return result
 
1139
 
 
1140
 
 
1141
    def revert(self, filenames, old_tree=None, backups=True):
 
1142
        """Restore selected files to the versions from a previous tree.
 
1143
 
 
1144
        backups
 
1145
            If true (default) backups are made of files before
 
1146
            they're renamed.
 
1147
        """
 
1148
        from bzrlib.errors import NotVersionedError, BzrError
 
1149
        from bzrlib.atomicfile import AtomicFile
 
1150
        from bzrlib.osutils import backup_file
 
1151
        
 
1152
        inv = self.read_working_inventory()
 
1153
        if old_tree is None:
 
1154
            old_tree = self.basis_tree()
 
1155
        old_inv = old_tree.inventory
 
1156
 
 
1157
        nids = []
 
1158
        for fn in filenames:
 
1159
            file_id = inv.path2id(fn)
 
1160
            if not file_id:
 
1161
                raise NotVersionedError("not a versioned file", fn)
 
1162
            if not old_inv.has_id(file_id):
 
1163
                raise BzrError("file not present in old tree", fn, file_id)
 
1164
            nids.append((fn, file_id))
 
1165
            
 
1166
        # TODO: Rename back if it was previously at a different location
 
1167
 
 
1168
        # TODO: If given a directory, restore the entire contents from
 
1169
        # the previous version.
 
1170
 
 
1171
        # TODO: Make a backup to a temporary file.
 
1172
 
 
1173
        # TODO: If the file previously didn't exist, delete it?
 
1174
        for fn, file_id in nids:
 
1175
            backup_file(fn)
 
1176
            
 
1177
            f = AtomicFile(fn, 'wb')
 
1178
            try:
 
1179
                f.write(old_tree.get_file(file_id).read())
 
1180
                f.commit()
 
1181
            finally:
 
1182
                f.close()
 
1183
 
 
1184
 
 
1185
    def pending_merges(self):
 
1186
        """Return a list of pending merges.
 
1187
 
 
1188
        These are revisions that have been merged into the working
 
1189
        directory but not yet committed.
 
1190
        """
 
1191
        cfn = self._rel_controlfilename('pending-merges')
 
1192
        if not self._transport.has(cfn):
 
1193
            return []
 
1194
        p = []
 
1195
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1196
            p.append(l.rstrip('\n'))
 
1197
        return p
 
1198
 
 
1199
 
 
1200
    def add_pending_merge(self, *revision_ids):
 
1201
        # TODO: Perhaps should check at this point that the
 
1202
        # history of the revision is actually present?
 
1203
        p = self.pending_merges()
 
1204
        updated = False
 
1205
        for rev_id in revision_ids:
 
1206
            if rev_id in p:
 
1207
                continue
 
1208
            p.append(rev_id)
 
1209
            updated = True
 
1210
        if updated:
 
1211
            self.set_pending_merges(p)
 
1212
 
 
1213
    def set_pending_merges(self, rev_list):
 
1214
        self.lock_write()
 
1215
        try:
 
1216
            self.put_controlfile('pending-merges', '\n'.join(rev_list))
 
1217
        finally:
 
1218
            self.unlock()
 
1219
 
 
1220
 
 
1221
    def get_parent(self):
 
1222
        """Return the parent location of the branch.
 
1223
 
 
1224
        This is the default location for push/pull/missing.  The usual
 
1225
        pattern is that the user can override it by specifying a
 
1226
        location.
 
1227
        """
 
1228
        import errno
 
1229
        _locs = ['parent', 'pull', 'x-pull']
 
1230
        for l in _locs:
 
1231
            try:
 
1232
                return self.controlfile(l, 'r').read().strip('\n')
 
1233
            except IOError, e:
 
1234
                if e.errno != errno.ENOENT:
 
1235
                    raise
 
1236
        return None
 
1237
 
 
1238
 
 
1239
    def set_parent(self, url):
 
1240
        # TODO: Maybe delete old location files?
 
1241
        from bzrlib.atomicfile import AtomicFile
 
1242
        self.lock_write()
 
1243
        try:
 
1244
            f = AtomicFile(self.controlfilename('parent'))
 
1245
            try:
 
1246
                f.write(url + '\n')
 
1247
                f.commit()
 
1248
            finally:
 
1249
                f.close()
 
1250
        finally:
 
1251
            self.unlock()
 
1252
 
 
1253
    def check_revno(self, revno):
 
1254
        """\
 
1255
        Check whether a revno corresponds to any revision.
 
1256
        Zero (the NULL revision) is considered valid.
 
1257
        """
 
1258
        if revno != 0:
 
1259
            self.check_real_revno(revno)
 
1260
            
 
1261
    def check_real_revno(self, revno):
 
1262
        """\
 
1263
        Check whether a revno corresponds to a real revision.
 
1264
        Zero (the NULL revision) is considered invalid
 
1265
        """
 
1266
        if revno < 1 or revno > self.revno():
 
1267
            raise InvalidRevisionNumber(revno)
 
1268
        
 
1269
        
 
1270
        
 
1271
 
 
1272
 
 
1273
class ScratchBranch(_Branch):
 
1274
    """Special test class: a branch that cleans up after itself.
 
1275
 
 
1276
    >>> b = ScratchBranch()
 
1277
    >>> isdir(b.base)
 
1278
    True
 
1279
    >>> bd = b.base
 
1280
    >>> b.destroy()
 
1281
    >>> isdir(bd)
 
1282
    False
 
1283
    """
 
1284
    def __init__(self, files=[], dirs=[], base=None):
 
1285
        """Make a test branch.
 
1286
 
 
1287
        This creates a temporary directory and runs init-tree in it.
 
1288
 
 
1289
        If any files are listed, they are created in the working copy.
 
1290
        """
 
1291
        from tempfile import mkdtemp
 
1292
        init = False
 
1293
        if base is None:
 
1294
            base = mkdtemp()
 
1295
            init = True
 
1296
        if isinstance(base, basestring):
 
1297
            base = get_transport(base)
 
1298
        _Branch.__init__(self, base, init=init)
 
1299
        for d in dirs:
 
1300
            self._transport.mkdir(d)
 
1301
            
 
1302
        for f in files:
 
1303
            self._transport.put(f, 'content of %s' % f)
 
1304
 
 
1305
 
 
1306
    def clone(self):
 
1307
        """
 
1308
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1309
        >>> clone = orig.clone()
 
1310
        >>> if os.name != 'nt':
 
1311
        ...   os.path.samefile(orig.base, clone.base)
 
1312
        ... else:
 
1313
        ...   orig.base == clone.base
 
1314
        ...
 
1315
        False
 
1316
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1317
        True
 
1318
        """
 
1319
        from shutil import copytree
 
1320
        from tempfile import mkdtemp
 
1321
        base = mkdtemp()
 
1322
        os.rmdir(base)
 
1323
        copytree(self.base, base, symlinks=True)
 
1324
        return ScratchBranch(base=base)
 
1325
 
 
1326
    def __del__(self):
 
1327
        self.destroy()
 
1328
 
 
1329
    def destroy(self):
 
1330
        """Destroy the test branch, removing the scratch directory."""
 
1331
        from shutil import rmtree
 
1332
        try:
 
1333
            if self.base:
 
1334
                mutter("delete ScratchBranch %s" % self.base)
 
1335
                rmtree(self.base)
 
1336
        except OSError, e:
 
1337
            # Work around for shutil.rmtree failing on Windows when
 
1338
            # readonly files are encountered
 
1339
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1340
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1341
                for name in files:
 
1342
                    os.chmod(os.path.join(root, name), 0700)
 
1343
            rmtree(self.base)
 
1344
        self._transport = None
 
1345
 
 
1346
    
 
1347
 
 
1348
######################################################################
 
1349
# predicates
 
1350
 
 
1351
 
 
1352
def is_control_file(filename):
 
1353
    ## FIXME: better check
 
1354
    filename = os.path.normpath(filename)
 
1355
    while filename != '':
 
1356
        head, tail = os.path.split(filename)
 
1357
        ## mutter('check %r for control file' % ((head, tail), ))
 
1358
        if tail == bzrlib.BZRDIR:
 
1359
            return True
 
1360
        if filename == head:
 
1361
            break
 
1362
        filename = head
 
1363
    return False
 
1364
 
 
1365
 
 
1366
 
 
1367
def gen_file_id(name):
 
1368
    """Return new file id.
 
1369
 
 
1370
    This should probably generate proper UUIDs, but for the moment we
 
1371
    cope with just randomness because running uuidgen every time is
 
1372
    slow."""
 
1373
    import re
 
1374
    from binascii import hexlify
 
1375
    from time import time
 
1376
 
 
1377
    # get last component
 
1378
    idx = name.rfind('/')
 
1379
    if idx != -1:
 
1380
        name = name[idx+1 : ]
 
1381
    idx = name.rfind('\\')
 
1382
    if idx != -1:
 
1383
        name = name[idx+1 : ]
 
1384
 
 
1385
    # make it not a hidden file
 
1386
    name = name.lstrip('.')
 
1387
 
 
1388
    # remove any wierd characters; we don't escape them but rather
 
1389
    # just pull them out
 
1390
    name = re.sub(r'[^\w.]', '', name)
 
1391
 
 
1392
    s = hexlify(rand_bytes(8))
 
1393
    return '-'.join((name, compact_date(time()), s))
 
1394
 
 
1395
 
 
1396
def gen_root_id():
 
1397
    """Return a new tree-root file id."""
 
1398
    return gen_file_id('TREE_ROOT')
 
1399
 
 
1400