/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: Aaron Bentley
  • Date: 2005-10-06 03:15:08 UTC
  • mto: (1185.12.13)
  • mto: This revision was merged to the branch mainline in revision 1419.
  • Revision ID: aaron.bentley@utoronto.ca-20051006031508-35ad4e5af9f9aff7
Added test_commit.py

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