/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2005-10-13 15:21:12 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1460.
  • Revision ID: abentley@panoramicfeedback.com-20051013152112-8744970e04966460
Made format_date more flexible

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