~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-06-21 06:10:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050621061017-12e8f0ff45228338
- move whitebox/blackbox modules into bzrlib.selftest subdirectory

Show diffs side-by-side

added added

removed removed

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