/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-03 05:54:35 UTC
  • mto: (1393.1.30)
  • mto: This revision was merged to the branch mainline in revision 1400.
  • Revision ID: robertc@robertcollins.net-20051003055434-c8ebd30d1de10247
move exporting functionality into inventory.py - uncovers bug in symlink support

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