/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-08 08:45:42 UTC
  • Revision ID: robertc@robertcollins.net-20051008084542-48ea5a99756f970e
add rm alias to remove

Show diffs side-by-side

added added

removed removed

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