~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2006-03-28 11:16:28 UTC
  • mto: (1626.2.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1628.
  • Revision ID: robertc@robertcollins.net-20060328111628-47766b0fdfa443ab
Add MergeSort facility to bzrlib.tsort.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
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
 
18
from copy import deepcopy
 
19
from cStringIO import StringIO
 
20
import errno
 
21
import os
 
22
import shutil
 
23
import sys
 
24
from unittest import TestSuite
 
25
from warnings import warn
21
26
 
22
27
import bzrlib
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"
36
 
## TODO: Maybe include checks for common corruption of newlines, etc?
37
 
 
38
 
 
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
 
 
49
 
def _relpath(base, path):
50
 
    """Return path relative to base, or raise exception.
51
 
 
52
 
    The path may be either an absolute path or a path relative to the
53
 
    current working directory.
54
 
 
55
 
    Lifted out of Branch.relpath for ease of testing.
56
 
 
57
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
58
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
59
 
    avoids that problem."""
60
 
    rp = os.path.abspath(path)
61
 
 
62
 
    s = []
63
 
    head = rp
64
 
    while len(head) >= len(base):
65
 
        if head == base:
66
 
            break
67
 
        head, tail = os.path.split(head)
68
 
        if tail:
69
 
            s.insert(0, tail)
70
 
    else:
71
 
        from errors import NotBranchError
72
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
73
 
 
74
 
    return os.sep.join(s)
75
 
        
76
 
 
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.
83
 
 
84
 
    Basically we keep looking up until we find the control directory or
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
 
 
98
 
    while True:
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:
103
 
            # reached the root, whatever that may be
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)
 
28
import bzrlib.bzrdir as bzrdir
 
29
from bzrlib.config import TreeConfig
 
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
31
from bzrlib.delta import compare_trees
 
32
import bzrlib.errors as errors
 
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
34
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
35
                           DivergedBranches, LockError,
 
36
                           UninitializableFormat,
 
37
                           UnlistableStore,
 
38
                           UnlistableBranch, NoSuchFile, NotVersionedError,
 
39
                           NoWorkingTree)
 
40
import bzrlib.inventory as inventory
 
41
from bzrlib.inventory import Inventory
 
42
from bzrlib.lockable_files import LockableFiles, TransportLock
 
43
from bzrlib.lockdir import LockDir
 
44
from bzrlib.osutils import (isdir, quotefn,
 
45
                            rename, splitpath, sha_file,
 
46
                            file_kind, abspath, normpath, pathjoin,
 
47
                            safe_unicode,
 
48
                            )
 
49
from bzrlib.textui import show_status
 
50
from bzrlib.trace import mutter, note
 
51
from bzrlib.tree import EmptyTree, RevisionTree
 
52
from bzrlib.repository import Repository
 
53
from bzrlib.revision import (
 
54
                             get_intervening_revisions,
 
55
                             is_ancestor,
 
56
                             NULL_REVISION,
 
57
                             Revision,
 
58
                             )
 
59
from bzrlib.store import copy_all
 
60
from bzrlib.symbol_versioning import *
 
61
import bzrlib.transactions as transactions
 
62
from bzrlib.transport import Transport, get_transport
 
63
from bzrlib.tree import EmptyTree, RevisionTree
 
64
import bzrlib.ui
 
65
import bzrlib.xml5
 
66
 
 
67
 
 
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
 
71
 
 
72
 
 
73
# TODO: Maybe include checks for common corruption of newlines, etc?
 
74
 
 
75
# TODO: Some operations like log might retrieve the same revisions
 
76
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
77
# cache in memory to make this faster.  In general anything can be
 
78
# cached in memory between lock and unlock operations. .. nb thats
 
79
# what the transaction identity map provides
120
80
 
121
81
 
122
82
######################################################################
126
86
    """Branch holding a history of revisions.
127
87
 
128
88
    base
129
 
        Base directory of the branch.
130
 
 
131
 
    _lock_mode
132
 
        None, or 'r' or 'w'
133
 
 
134
 
    _lock_count
135
 
        If _lock_mode is true, a positive count of the number of times the
136
 
        lock has been taken.
137
 
 
138
 
    _lock
139
 
        Lock object from bzrlib.lock.
 
89
        Base directory/url of the branch.
140
90
    """
 
91
    # this is really an instance variable - FIXME move it there
 
92
    # - RBC 20060112
141
93
    base = None
142
 
    _lock_mode = None
143
 
    _lock_count = None
144
 
    _lock = None
145
 
    
146
 
    def __init__(self, base, init=False, find_root=True):
147
 
        """Create new branch object at a particular location.
148
 
 
149
 
        base -- Base directory for the branch.
150
 
        
151
 
        init -- If True, create new control files in a previously
152
 
             unversioned directory.  If False, the branch must already
153
 
             be versioned.
154
 
 
155
 
        find_root -- If true and init is false, find the root of the
156
 
             existing branch containing base.
157
 
 
158
 
        In the test suite, creation of new trees is tested using the
159
 
        `ScratchBranch` class.
160
 
        """
161
 
        if init:
162
 
            self.base = os.path.realpath(base)
163
 
            self._make_control()
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
 
 
179
 
 
180
 
    def __str__(self):
181
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
182
 
 
183
 
 
184
 
    __repr__ = __str__
185
 
 
186
 
 
187
 
    def __del__(self):
188
 
        if self._lock_mode or self._lock:
189
 
            from warnings import warn
190
 
            warn("branch %r was not explicitly unlocked" % self)
191
 
            self._lock.unlock()
192
 
 
193
 
 
194
 
 
 
94
 
 
95
    def __init__(self, *ignored, **ignored_too):
 
96
        raise NotImplementedError('The Branch class is abstract')
 
97
 
 
98
    @staticmethod
 
99
    @deprecated_method(zero_eight)
 
100
    def open_downlevel(base):
 
101
        """Open a branch which may be of an old format."""
 
102
        return Branch.open(base, _unsupported=True)
 
103
        
 
104
    @staticmethod
 
105
    def open(base, _unsupported=False):
 
106
        """Open the repository rooted at base.
 
107
 
 
108
        For instance, if the repository is at URL/.bzr/repository,
 
109
        Repository.open(URL) -> a Repository instance.
 
110
        """
 
111
        control = bzrdir.BzrDir.open(base, _unsupported)
 
112
        return control.open_branch(_unsupported)
 
113
 
 
114
    @staticmethod
 
115
    def open_containing(url):
 
116
        """Open an existing branch which contains url.
 
117
        
 
118
        This probes for a branch at url, and searches upwards from there.
 
119
 
 
120
        Basically we keep looking up until we find the control directory or
 
121
        run into the root.  If there isn't one, raises NotBranchError.
 
122
        If there is one and it is either an unrecognised format or an unsupported 
 
123
        format, UnknownFormatError or UnsupportedFormatError are raised.
 
124
        If there is one, it is returned, along with the unused portion of url.
 
125
        """
 
126
        control, relpath = bzrdir.BzrDir.open_containing(url)
 
127
        return control.open_branch(), relpath
 
128
 
 
129
    @staticmethod
 
130
    @deprecated_function(zero_eight)
 
131
    def initialize(base):
 
132
        """Create a new working tree and branch, rooted at 'base' (url)
 
133
 
 
134
        NOTE: This will soon be deprecated in favour of creation
 
135
        through a BzrDir.
 
136
        """
 
137
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
 
138
 
 
139
    def setup_caching(self, cache_root):
 
140
        """Subclasses that care about caching should override this, and set
 
141
        up cached stores located under cache_root.
 
142
        """
 
143
        # seems to be unused, 2006-01-13 mbp
 
144
        warn('%s is deprecated' % self.setup_caching)
 
145
        self.cache_root = cache_root
 
146
 
 
147
    def _get_nick(self):
 
148
        cfg = self.tree_config()
 
149
        return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
 
150
 
 
151
    def _set_nick(self, nick):
 
152
        cfg = self.tree_config()
 
153
        cfg.set_option(nick, "nickname")
 
154
        assert cfg.get_option("nickname") == nick
 
155
 
 
156
    nick = property(_get_nick, _set_nick)
 
157
        
195
158
    def lock_write(self):
196
 
        if self._lock_mode:
197
 
            if self._lock_mode != 'w':
198
 
                from errors import LockError
199
 
                raise LockError("can't upgrade to a write lock from %r" %
200
 
                                self._lock_mode)
201
 
            self._lock_count += 1
202
 
        else:
203
 
            from bzrlib.lock import WriteLock
204
 
 
205
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
206
 
            self._lock_mode = 'w'
207
 
            self._lock_count = 1
208
 
 
209
 
 
210
 
 
 
159
        raise NotImplementedError('lock_write is abstract')
 
160
        
211
161
    def lock_read(self):
212
 
        if self._lock_mode:
213
 
            assert self._lock_mode in ('r', 'w'), \
214
 
                   "invalid lock mode %r" % self._lock_mode
215
 
            self._lock_count += 1
216
 
        else:
217
 
            from bzrlib.lock import ReadLock
218
 
 
219
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
220
 
            self._lock_mode = 'r'
221
 
            self._lock_count = 1
222
 
                        
223
 
 
224
 
            
 
162
        raise NotImplementedError('lock_read is abstract')
 
163
 
225
164
    def unlock(self):
226
 
        if not self._lock_mode:
227
 
            from errors import LockError
228
 
            raise LockError('branch %r is not locked' % (self))
229
 
 
230
 
        if self._lock_count > 1:
231
 
            self._lock_count -= 1
232
 
        else:
233
 
            self._lock.unlock()
234
 
            self._lock = None
235
 
            self._lock_mode = self._lock_count = None
236
 
 
 
165
        raise NotImplementedError('unlock is abstract')
 
166
 
 
167
    def peek_lock_mode(self):
 
168
        """Return lock mode for the Branch: 'r', 'w' or None"""
 
169
        raise NotImplementedError(self.peek_lock_mode)
237
170
 
238
171
    def abspath(self, name):
239
 
        """Return absolute filename for something in the branch"""
240
 
        return os.path.join(self.base, name)
241
 
 
242
 
 
243
 
    def relpath(self, path):
244
 
        """Return path relative to this branch of something inside it.
245
 
 
246
 
        Raises an error if path is not in this branch."""
247
 
        return _relpath(self.base, path)
248
 
 
249
 
 
250
 
    def controlfilename(self, file_or_path):
251
 
        """Return location relative to branch."""
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)
255
 
 
256
 
 
257
 
    def controlfile(self, file_or_path, mode='r'):
258
 
        """Open a control file for this branch.
259
 
 
260
 
        There are two classes of file in the control directory: text
261
 
        and binary.  binary files are untranslated byte streams.  Text
262
 
        control files are stored with Unix newlines and in UTF-8, even
263
 
        if the platform or locale defaults are different.
264
 
 
265
 
        Controlfiles should almost never be opened in write mode but
266
 
        rather should be atomically copied and replaced using atomicfile.
267
 
        """
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)
279
 
        else:
280
 
            raise BzrError("invalid controlfile mode %r" % mode)
281
 
 
282
 
 
283
 
 
284
 
    def _make_control(self):
285
 
        os.mkdir(self.controlfilename([]))
286
 
        self.controlfile('README', 'w').write(
287
 
            "This is a Bazaar-NG control directory.\n"
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):
301
 
        """Check this branch format is supported.
302
 
 
303
 
        The current tool only supports the current unstable format.
304
 
 
305
 
        In the future, we might need different in-memory Branch
306
 
        classes to support downlevel branches.  But not yet.
307
 
        """
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:
314
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
315
 
                           ['use a different bzr version',
316
 
                            'or remove the .bzr directory and "bzr init" again'])
317
 
 
318
 
 
319
 
 
320
 
    def read_working_inventory(self):
321
 
        """Read the working inventory."""
322
 
        before = time.time()
323
 
        # ElementTree does its own conversion from UTF-8, so open in
324
 
        # binary.
325
 
        self.lock_read()
326
 
        try:
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
331
 
        finally:
332
 
            self.unlock()
333
 
            
334
 
 
335
 
    def _write_inventory(self, inv):
336
 
        """Update the working inventory.
337
 
 
338
 
        That is to say, the inventory describing changes underway, that
339
 
        will be committed to the next revision.
340
 
        """
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)
351
 
        mutter('wrote working inventory')
352
 
            
353
 
 
354
 
    inventory = property(read_working_inventory, _write_inventory, None,
355
 
                         """Inventory for the working copy.""")
356
 
 
357
 
 
358
 
    def add(self, files, verbose=False, ids=None):
359
 
        """Make files versioned.
360
 
 
361
 
        Note that the command line normally calls smart_add instead.
362
 
 
363
 
        This puts the files in the Added state, so that they will be
364
 
        recorded by the next commit.
365
 
 
366
 
        files
367
 
            List of paths to add, relative to the base of the tree.
368
 
 
369
 
        ids
370
 
            If set, use these instead of automatically generated ids.
371
 
            Must be the same length as the list of files, but may
372
 
            contain None for ids that are to be autogenerated.
373
 
 
374
 
        TODO: Perhaps have an option to add the ids even if the files do
375
 
              not (yet) exist.
376
 
 
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.
383
 
        """
384
 
        # TODO: Re-adding a file that is removed in the working copy
385
 
        # should probably put it back with the previous ID.
386
 
        if isinstance(files, types.StringTypes):
387
 
            assert(ids is None or isinstance(ids, types.StringTypes))
388
 
            files = [files]
389
 
            if ids is not None:
390
 
                ids = [ids]
391
 
 
392
 
        if ids is None:
393
 
            ids = [None] * len(files)
394
 
        else:
395
 
            assert(len(ids) == len(files))
396
 
 
397
 
        self.lock_write()
398
 
        try:
399
 
            inv = self.read_working_inventory()
400
 
            for f,file_id in zip(files, ids):
401
 
                if is_control_file(f):
402
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
403
 
 
404
 
                fp = splitpath(f)
405
 
 
406
 
                if len(fp) == 0:
407
 
                    raise BzrError("cannot add top-level %r" % f)
408
 
 
409
 
                fullpath = os.path.normpath(self.abspath(f))
410
 
 
411
 
                try:
412
 
                    kind = file_kind(fullpath)
413
 
                except OSError:
414
 
                    # maybe something better?
415
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
416
 
 
417
 
                if kind != 'file' and kind != 'directory':
418
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
419
 
 
420
 
                if file_id is None:
421
 
                    file_id = gen_file_id(f)
422
 
                inv.add_path(f, kind=kind, file_id=file_id)
423
 
 
424
 
                if verbose:
425
 
                    show_status('A', kind, quotefn(f))
426
 
 
427
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
428
 
 
429
 
            self._write_inventory(inv)
430
 
        finally:
431
 
            self.unlock()
432
 
            
433
 
 
434
 
    def print_file(self, file, revno):
 
172
        """Return absolute filename for something in the branch
 
173
        
 
174
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
175
        method and not a tree method.
 
176
        """
 
177
        raise NotImplementedError('abspath is abstract')
 
178
 
 
179
    def bind(self, other):
 
180
        """Bind the local branch the other branch.
 
181
 
 
182
        :param other: The branch to bind to
 
183
        :type other: Branch
 
184
        """
 
185
        raise errors.UpgradeRequired(self.base)
 
186
 
 
187
    @needs_write_lock
 
188
    def fetch(self, from_branch, last_revision=None, pb=None):
 
189
        """Copy revisions from from_branch into this branch.
 
190
 
 
191
        :param from_branch: Where to copy from.
 
192
        :param last_revision: What revision to stop at (None for at the end
 
193
                              of the branch.
 
194
        :param pb: An optional progress bar to use.
 
195
 
 
196
        Returns the copied revision count and the failed revisions in a tuple:
 
197
        (copied, failures).
 
198
        """
 
199
        if self.base == from_branch.base:
 
200
            return (0, [])
 
201
        if pb is None:
 
202
            nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
203
            pb = nested_pb
 
204
        else:
 
205
            nested_pb = None
 
206
 
 
207
        from_branch.lock_read()
 
208
        try:
 
209
            if last_revision is None:
 
210
                pb.update('get source history')
 
211
                from_history = from_branch.revision_history()
 
212
                if from_history:
 
213
                    last_revision = from_history[-1]
 
214
                else:
 
215
                    # no history in the source branch
 
216
                    last_revision = NULL_REVISION
 
217
            return self.repository.fetch(from_branch.repository,
 
218
                                         revision_id=last_revision,
 
219
                                         pb=nested_pb)
 
220
        finally:
 
221
            if nested_pb is not None:
 
222
                nested_pb.finished()
 
223
            from_branch.unlock()
 
224
 
 
225
    def get_bound_location(self):
 
226
        """Return the URL of the rbanch we are bound to.
 
227
 
 
228
        Older format branches cannot bind, please be sure to use a metadir
 
229
        branch.
 
230
        """
 
231
        return None
 
232
 
 
233
    def get_master_branch(self):
 
234
        """Return the branch we are bound to.
 
235
        
 
236
        :return: Either a Branch, or None
 
237
        """
 
238
        return None
 
239
 
 
240
    def get_root_id(self):
 
241
        """Return the id of this branches root"""
 
242
        raise NotImplementedError('get_root_id is abstract')
 
243
 
 
244
    def print_file(self, file, revision_id):
435
245
        """Print `file` to stdout."""
436
 
        self.lock_read()
437
 
        try:
438
 
            tree = self.revision_tree(self.lookup_revision(revno))
439
 
            # use inventory as it was in that revision
440
 
            file_id = tree.inventory.path2id(file)
441
 
            if not file_id:
442
 
                raise BzrError("%r is not present in revision %d" % (file, revno))
443
 
            tree.print_file(file_id)
444
 
        finally:
445
 
            self.unlock()
446
 
 
447
 
 
448
 
    def remove(self, files, verbose=False):
449
 
        """Mark nominated files for removal from the inventory.
450
 
 
451
 
        This does not remove their text.  This does not run on 
452
 
 
453
 
        TODO: Refuse to remove modified files unless --force is given?
454
 
 
455
 
        TODO: Do something useful with directories.
456
 
 
457
 
        TODO: Should this remove the text or not?  Tough call; not
458
 
        removing may be useful and the user can just use use rm, and
459
 
        is the opposite of add.  Removing it is consistent with most
460
 
        other tools.  Maybe an option.
461
 
        """
462
 
        ## TODO: Normalize names
463
 
        ## TODO: Remove nested loops; better scalability
464
 
        if isinstance(files, types.StringTypes):
465
 
            files = [files]
466
 
 
467
 
        self.lock_write()
468
 
 
469
 
        try:
470
 
            tree = self.working_tree()
471
 
            inv = tree.inventory
472
 
 
473
 
            # do this before any modifications
474
 
            for f in files:
475
 
                fid = inv.path2id(f)
476
 
                if not fid:
477
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
478
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
479
 
                if verbose:
480
 
                    # having remove it, it must be either ignored or unknown
481
 
                    if tree.is_ignored(f):
482
 
                        new_status = 'I'
483
 
                    else:
484
 
                        new_status = '?'
485
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
486
 
                del inv[fid]
487
 
 
488
 
            self._write_inventory(inv)
489
 
        finally:
490
 
            self.unlock()
491
 
 
492
 
 
493
 
    # FIXME: this doesn't need to be a branch method
494
 
    def set_inventory(self, new_inventory_list):
495
 
        inv = Inventory()
496
 
        for path, file_id, parent, kind in new_inventory_list:
497
 
            name = os.path.basename(path)
498
 
            if name == "":
499
 
                continue
500
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
501
 
        self._write_inventory(inv)
502
 
 
503
 
 
504
 
    def unknowns(self):
505
 
        """Return all unknown files.
506
 
 
507
 
        These are files in the working directory that are not versioned or
508
 
        control files or ignored.
509
 
        
510
 
        >>> b = ScratchBranch(files=['foo', 'foo~'])
511
 
        >>> list(b.unknowns())
512
 
        ['foo']
513
 
        >>> b.add('foo')
514
 
        >>> list(b.unknowns())
515
 
        []
516
 
        >>> b.remove('foo')
517
 
        >>> list(b.unknowns())
518
 
        ['foo']
519
 
        """
520
 
        return self.working_tree().unknowns()
521
 
 
522
 
 
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
 
        
540
 
 
541
 
 
542
 
    def get_revision(self, revision_id):
543
 
        """Return the Revision object for a named revision"""
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])
547
 
        assert r.revision_id == revision_id
548
 
        return r
549
 
 
550
 
    def get_revision_sha1(self, revision_id):
551
 
        """Hash the stored value of a revision, and return it."""
552
 
        # In the future, revision entries will be signed. At that
553
 
        # point, it is probably best *not* to include the signature
554
 
        # in the revision hash. Because that lets you re-sign
555
 
        # the revision, (add signatures/remove signatures) and still
556
 
        # have all hash pointers stay consistent.
557
 
        # But for now, just hash the contents.
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):
571
 
        """Return the sha1 hash of the inventory entry
572
 
        """
573
 
        return sha_file(self.inventory_store[inventory_id])
574
 
 
575
 
 
576
 
    def get_revision_inventory(self, revision_id):
577
 
        """Return inventory of a past revision."""
578
 
        if revision_id == None:
579
 
            return Inventory()
580
 
        else:
581
 
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
582
 
 
 
246
        raise NotImplementedError('print_file is abstract')
 
247
 
 
248
    def append_revision(self, *revision_ids):
 
249
        raise NotImplementedError('append_revision is abstract')
 
250
 
 
251
    def set_revision_history(self, rev_history):
 
252
        raise NotImplementedError('set_revision_history is abstract')
583
253
 
584
254
    def revision_history(self):
585
 
        """Return sequence of revision hashes on to this branch.
586
 
 
587
 
        >>> ScratchBranch().revision_history()
588
 
        []
589
 
        """
590
 
        self.lock_read()
591
 
        try:
592
 
            return [l.rstrip('\r\n') for l in
593
 
                    self.controlfile('revision-history', 'r').readlines()]
594
 
        finally:
595
 
            self.unlock()
596
 
 
597
 
 
598
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
599
 
        """
600
 
        >>> import commit
601
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
602
 
        >>> sb.common_ancestor(sb) == (None, None)
603
 
        True
604
 
        >>> commit.commit(sb, "Committing first revision", verbose=False)
605
 
        >>> sb.common_ancestor(sb)[0]
606
 
        1
607
 
        >>> clone = sb.clone()
608
 
        >>> commit.commit(sb, "Committing second revision", verbose=False)
609
 
        >>> sb.common_ancestor(sb)[0]
610
 
        2
611
 
        >>> sb.common_ancestor(clone)[0]
612
 
        1
613
 
        >>> commit.commit(clone, "Committing divergent second revision", 
614
 
        ...               verbose=False)
615
 
        >>> sb.common_ancestor(clone)[0]
616
 
        1
617
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
618
 
        True
619
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
620
 
        True
621
 
        >>> clone2 = sb.clone()
622
 
        >>> sb.common_ancestor(clone2)[0]
623
 
        2
624
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
625
 
        1
626
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
627
 
        1
628
 
        """
629
 
        my_history = self.revision_history()
630
 
        other_history = other.revision_history()
631
 
        if self_revno is None:
632
 
            self_revno = len(my_history)
633
 
        if other_revno is None:
634
 
            other_revno = len(other_history)
635
 
        indices = range(min((self_revno, other_revno)))
636
 
        indices.reverse()
637
 
        for r in indices:
638
 
            if my_history[r] == other_history[r]:
639
 
                return r+1, my_history[r]
640
 
        return None, None
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
 
 
 
255
        """Return sequence of revision hashes on to this branch."""
 
256
        raise NotImplementedError('revision_history is abstract')
663
257
 
664
258
    def revno(self):
665
259
        """Return current revision number for this branch.
669
263
        """
670
264
        return len(self.revision_history())
671
265
 
 
266
    def unbind(self):
 
267
        """Older format branches cannot bind or unbind."""
 
268
        raise errors.UpgradeRequired(self.base)
672
269
 
673
 
    def last_patch(self):
674
 
        """Return last patch hash, or None if no history.
675
 
        """
 
270
    def last_revision(self):
 
271
        """Return last patch hash, or None if no history."""
676
272
        ph = self.revision_history()
677
273
        if ph:
678
274
            return ph[-1]
679
275
        else:
680
276
            return None
681
277
 
682
 
 
683
278
    def missing_revisions(self, other, stop_revision=None):
684
 
        """
 
279
        """Return a list of new revisions that would perfectly fit.
 
280
        
685
281
        If self and other have not diverged, return a list of the revisions
686
282
        present in other, but missing from self.
687
283
 
688
 
        >>> from bzrlib.commit import commit
 
284
        >>> from bzrlib.workingtree import WorkingTree
689
285
        >>> bzrlib.trace.silent = True
690
 
        >>> br1 = ScratchBranch()
691
 
        >>> br2 = ScratchBranch()
 
286
        >>> d1 = bzrdir.ScratchDir()
 
287
        >>> br1 = d1.open_branch()
 
288
        >>> wt1 = d1.open_workingtree()
 
289
        >>> d2 = bzrdir.ScratchDir()
 
290
        >>> br2 = d2.open_branch()
 
291
        >>> wt2 = d2.open_workingtree()
692
292
        >>> br1.missing_revisions(br2)
693
293
        []
694
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
294
        >>> wt2.commit("lala!", rev_id="REVISION-ID-1")
695
295
        >>> br1.missing_revisions(br2)
696
296
        [u'REVISION-ID-1']
697
297
        >>> br2.missing_revisions(br1)
698
298
        []
699
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
299
        >>> wt1.commit("lala!", rev_id="REVISION-ID-1")
700
300
        >>> br1.missing_revisions(br2)
701
301
        []
702
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
302
        >>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
703
303
        >>> br1.missing_revisions(br2)
704
304
        [u'REVISION-ID-2A']
705
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
305
        >>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
706
306
        >>> br1.missing_revisions(br2)
707
307
        Traceback (most recent call last):
708
 
        DivergedBranches: These branches have diverged.
 
308
        DivergedBranches: These branches have diverged.  Try merge.
709
309
        """
710
310
        self_history = self.revision_history()
711
311
        self_len = len(self_history)
718
318
 
719
319
        if stop_revision is None:
720
320
            stop_revision = other_len
721
 
        elif stop_revision > other_len:
722
 
            raise NoSuchRevision(self, stop_revision)
723
 
        
 
321
        else:
 
322
            assert isinstance(stop_revision, int)
 
323
            if stop_revision > other_len:
 
324
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
724
325
        return other_history[self_len:stop_revision]
725
326
 
726
 
 
727
327
    def update_revisions(self, other, stop_revision=None):
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
 
328
        """Pull in new perfect-fit revisions.
 
329
 
 
330
        :param other: Another Branch to pull from
 
331
        :param stop_revision: Updated until the given revision
 
332
        :return: None
749
333
        """
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
 
        
787
 
    def commit(self, *args, **kw):
788
 
        """Deprecated"""
789
 
        from bzrlib.commit import commit
790
 
        commit(self, *args, **kw)
791
 
        
792
 
 
793
 
    def lookup_revision(self, revno):
794
 
        """Return revision hash for revision number."""
 
334
        raise NotImplementedError('update_revisions is abstract')
 
335
 
 
336
    def pullable_revisions(self, other, stop_revision):
 
337
        raise NotImplementedError('pullable_revisions is abstract')
 
338
        
 
339
    def revision_id_to_revno(self, revision_id):
 
340
        """Given a revision id, return its revno"""
 
341
        if revision_id is None:
 
342
            return 0
 
343
        history = self.revision_history()
 
344
        try:
 
345
            return history.index(revision_id) + 1
 
346
        except ValueError:
 
347
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
348
 
 
349
    def get_rev_id(self, revno, history=None):
 
350
        """Find the revision id of the specified revno."""
795
351
        if revno == 0:
796
352
            return None
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
 
 
804
 
 
805
 
    def revision_tree(self, revision_id):
806
 
        """Return Tree for a revision on this branch.
807
 
 
808
 
        `revision_id` may be None for the null revision, in which case
809
 
        an `EmptyTree` is returned."""
810
 
        # TODO: refactor this to use an existing revision object
811
 
        # so we don't need to read it in twice.
812
 
        if revision_id == None:
813
 
            return EmptyTree()
814
 
        else:
815
 
            inv = self.get_revision_inventory(revision_id)
816
 
            return RevisionTree(self.text_store, inv)
817
 
 
818
 
 
819
 
    def working_tree(self):
820
 
        """Return a `Tree` for the working copy."""
821
 
        from workingtree import WorkingTree
822
 
        return WorkingTree(self.base, self.read_working_inventory())
823
 
 
 
353
        if history is None:
 
354
            history = self.revision_history()
 
355
        elif revno <= 0 or revno > len(history):
 
356
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
357
        return history[revno - 1]
 
358
 
 
359
    def pull(self, source, overwrite=False, stop_revision=None):
 
360
        raise NotImplementedError('pull is abstract')
824
361
 
825
362
    def basis_tree(self):
826
363
        """Return `Tree` object for last revision.
827
364
 
828
365
        If there are no revisions yet, return an `EmptyTree`.
829
366
        """
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
 
 
836
 
 
 
367
        return self.repository.revision_tree(self.last_revision())
837
368
 
838
369
    def rename_one(self, from_rel, to_rel):
839
370
        """Rename one file.
840
371
 
841
372
        This can change the directory or the filename or both.
842
373
        """
843
 
        self.lock_write()
844
 
        try:
845
 
            tree = self.working_tree()
846
 
            inv = tree.inventory
847
 
            if not tree.has_filename(from_rel):
848
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
849
 
            if tree.has_filename(to_rel):
850
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
851
 
 
852
 
            file_id = inv.path2id(from_rel)
853
 
            if file_id == None:
854
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
855
 
 
856
 
            if inv.path2id(to_rel):
857
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
858
 
 
859
 
            to_dir, to_tail = os.path.split(to_rel)
860
 
            to_dir_id = inv.path2id(to_dir)
861
 
            if to_dir_id == None and to_dir != '':
862
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
863
 
 
864
 
            mutter("rename_one:")
865
 
            mutter("  file_id    {%s}" % file_id)
866
 
            mutter("  from_rel   %r" % from_rel)
867
 
            mutter("  to_rel     %r" % to_rel)
868
 
            mutter("  to_dir     %r" % to_dir)
869
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
870
 
 
871
 
            inv.rename(file_id, to_dir_id, to_tail)
872
 
 
873
 
            print "%s => %s" % (from_rel, to_rel)
874
 
 
875
 
            from_abs = self.abspath(from_rel)
876
 
            to_abs = self.abspath(to_rel)
877
 
            try:
878
 
                os.rename(from_abs, to_abs)
879
 
            except OSError, e:
880
 
                raise BzrError("failed to rename %r to %r: %s"
881
 
                        % (from_abs, to_abs, e[1]),
882
 
                        ["rename rolled back"])
883
 
 
884
 
            self._write_inventory(inv)
885
 
        finally:
886
 
            self.unlock()
887
 
 
 
374
        raise NotImplementedError('rename_one is abstract')
888
375
 
889
376
    def move(self, from_paths, to_name):
890
377
        """Rename files.
896
383
 
897
384
        Note that to_name is only the last component of the new name;
898
385
        this doesn't change the directory.
899
 
        """
900
 
        self.lock_write()
901
 
        try:
902
 
            ## TODO: Option to move IDs only
903
 
            assert not isinstance(from_paths, basestring)
904
 
            tree = self.working_tree()
905
 
            inv = tree.inventory
906
 
            to_abs = self.abspath(to_name)
907
 
            if not isdir(to_abs):
908
 
                raise BzrError("destination %r is not a directory" % to_abs)
909
 
            if not tree.has_filename(to_name):
910
 
                raise BzrError("destination %r not in working directory" % to_abs)
911
 
            to_dir_id = inv.path2id(to_name)
912
 
            if to_dir_id == None and to_name != '':
913
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
914
 
            to_dir_ie = inv[to_dir_id]
915
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
916
 
                raise BzrError("destination %r is not a directory" % to_abs)
917
 
 
918
 
            to_idpath = inv.get_idpath(to_dir_id)
919
 
 
920
 
            for f in from_paths:
921
 
                if not tree.has_filename(f):
922
 
                    raise BzrError("%r does not exist in working tree" % f)
923
 
                f_id = inv.path2id(f)
924
 
                if f_id == None:
925
 
                    raise BzrError("%r is not versioned" % f)
926
 
                name_tail = splitpath(f)[-1]
927
 
                dest_path = appendpath(to_name, name_tail)
928
 
                if tree.has_filename(dest_path):
929
 
                    raise BzrError("destination %r already exists" % dest_path)
930
 
                if f_id in to_idpath:
931
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
932
 
 
933
 
            # OK, so there's a race here, it's possible that someone will
934
 
            # create a file in this interval and then the rename might be
935
 
            # left half-done.  But we should have caught most problems.
936
 
 
937
 
            for f in from_paths:
938
 
                name_tail = splitpath(f)[-1]
939
 
                dest_path = appendpath(to_name, name_tail)
940
 
                print "%s => %s" % (f, dest_path)
941
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
942
 
                try:
943
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
944
 
                except OSError, e:
945
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
946
 
                            ["rename rolled back"])
947
 
 
948
 
            self._write_inventory(inv)
949
 
        finally:
950
 
            self.unlock()
951
 
 
952
 
 
953
 
 
954
 
class ScratchBranch(Branch):
955
 
    """Special test class: a branch that cleans up after itself.
956
 
 
957
 
    >>> b = ScratchBranch()
958
 
    >>> isdir(b.base)
959
 
    True
960
 
    >>> bd = b.base
961
 
    >>> b.destroy()
962
 
    >>> isdir(bd)
963
 
    False
964
 
    """
965
 
    def __init__(self, files=[], dirs=[], base=None):
966
 
        """Make a test branch.
967
 
 
968
 
        This creates a temporary directory and runs init-tree in it.
969
 
 
970
 
        If any files are listed, they are created in the working copy.
971
 
        """
972
 
        init = False
973
 
        if base is None:
974
 
            base = tempfile.mkdtemp()
975
 
            init = True
976
 
        Branch.__init__(self, base, init=init)
977
 
        for d in dirs:
978
 
            os.mkdir(self.abspath(d))
 
386
 
 
387
        This returns a list of (from_path, to_path) pairs for each
 
388
        entry that is moved.
 
389
        """
 
390
        raise NotImplementedError('move is abstract')
 
391
 
 
392
    def get_parent(self):
 
393
        """Return the parent location of the branch.
 
394
 
 
395
        This is the default location for push/pull/missing.  The usual
 
396
        pattern is that the user can override it by specifying a
 
397
        location.
 
398
        """
 
399
        raise NotImplementedError('get_parent is abstract')
 
400
 
 
401
    def get_push_location(self):
 
402
        """Return the None or the location to push this branch to."""
 
403
        raise NotImplementedError('get_push_location is abstract')
 
404
 
 
405
    def set_push_location(self, location):
 
406
        """Set a new push location for this branch."""
 
407
        raise NotImplementedError('set_push_location is abstract')
 
408
 
 
409
    def set_parent(self, url):
 
410
        raise NotImplementedError('set_parent is abstract')
 
411
 
 
412
    @needs_write_lock
 
413
    def update(self):
 
414
        """Synchronise this branch with the master branch if any. 
 
415
 
 
416
        :return: None or the last_revision pivoted out during the update.
 
417
        """
 
418
        return None
 
419
 
 
420
    def check_revno(self, revno):
 
421
        """\
 
422
        Check whether a revno corresponds to any revision.
 
423
        Zero (the NULL revision) is considered valid.
 
424
        """
 
425
        if revno != 0:
 
426
            self.check_real_revno(revno)
979
427
            
980
 
        for f in files:
981
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
982
 
 
983
 
 
984
 
    def clone(self):
985
 
        """
986
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
987
 
        >>> clone = orig.clone()
988
 
        >>> os.path.samefile(orig.base, clone.base)
989
 
        False
990
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
991
 
        True
992
 
        """
993
 
        base = tempfile.mkdtemp()
994
 
        os.rmdir(base)
995
 
        shutil.copytree(self.base, base, symlinks=True)
996
 
        return ScratchBranch(base=base)
997
 
        
 
428
    def check_real_revno(self, revno):
 
429
        """\
 
430
        Check whether a revno corresponds to a real revision.
 
431
        Zero (the NULL revision) is considered invalid
 
432
        """
 
433
        if revno < 1 or revno > self.revno():
 
434
            raise InvalidRevisionNumber(revno)
 
435
 
 
436
    @needs_read_lock
 
437
    def clone(self, *args, **kwargs):
 
438
        """Clone this branch into to_bzrdir preserving all semantic values.
 
439
        
 
440
        revision_id: if not None, the revision history in the new branch will
 
441
                     be truncated to end with revision_id.
 
442
        """
 
443
        # for API compatability, until 0.8 releases we provide the old api:
 
444
        # def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
 
445
        # after 0.8 releases, the *args and **kwargs should be changed:
 
446
        # def clone(self, to_bzrdir, revision_id=None):
 
447
        if (kwargs.get('to_location', None) or
 
448
            kwargs.get('revision', None) or
 
449
            kwargs.get('basis_branch', None) or
 
450
            (len(args) and isinstance(args[0], basestring))):
 
451
            # backwards compatability api:
 
452
            warn("Branch.clone() has been deprecated for BzrDir.clone() from"
 
453
                 " bzrlib 0.8.", DeprecationWarning, stacklevel=3)
 
454
            # get basis_branch
 
455
            if len(args) > 2:
 
456
                basis_branch = args[2]
 
457
            else:
 
458
                basis_branch = kwargs.get('basis_branch', None)
 
459
            if basis_branch:
 
460
                basis = basis_branch.bzrdir
 
461
            else:
 
462
                basis = None
 
463
            # get revision
 
464
            if len(args) > 1:
 
465
                revision_id = args[1]
 
466
            else:
 
467
                revision_id = kwargs.get('revision', None)
 
468
            # get location
 
469
            if len(args):
 
470
                url = args[0]
 
471
            else:
 
472
                # no default to raise if not provided.
 
473
                url = kwargs.get('to_location')
 
474
            return self.bzrdir.clone(url,
 
475
                                     revision_id=revision_id,
 
476
                                     basis=basis).open_branch()
 
477
        # new cleaner api.
 
478
        # generate args by hand 
 
479
        if len(args) > 1:
 
480
            revision_id = args[1]
 
481
        else:
 
482
            revision_id = kwargs.get('revision_id', None)
 
483
        if len(args):
 
484
            to_bzrdir = args[0]
 
485
        else:
 
486
            # no default to raise if not provided.
 
487
            to_bzrdir = kwargs.get('to_bzrdir')
 
488
        result = self._format.initialize(to_bzrdir)
 
489
        self.copy_content_into(result, revision_id=revision_id)
 
490
        return  result
 
491
 
 
492
    @needs_read_lock
 
493
    def sprout(self, to_bzrdir, revision_id=None):
 
494
        """Create a new line of development from the branch, into to_bzrdir.
 
495
        
 
496
        revision_id: if not None, the revision history in the new branch will
 
497
                     be truncated to end with revision_id.
 
498
        """
 
499
        result = self._format.initialize(to_bzrdir)
 
500
        self.copy_content_into(result, revision_id=revision_id)
 
501
        result.set_parent(self.bzrdir.root_transport.base)
 
502
        return result
 
503
 
 
504
    @needs_read_lock
 
505
    def copy_content_into(self, destination, revision_id=None):
 
506
        """Copy the content of self into destination.
 
507
 
 
508
        revision_id: if not None, the revision history in the new branch will
 
509
                     be truncated to end with revision_id.
 
510
        """
 
511
        new_history = self.revision_history()
 
512
        if revision_id is not None:
 
513
            try:
 
514
                new_history = new_history[:new_history.index(revision_id) + 1]
 
515
            except ValueError:
 
516
                rev = self.repository.get_revision(revision_id)
 
517
                new_history = rev.get_history(self.repository)[1:]
 
518
        destination.set_revision_history(new_history)
 
519
        parent = self.get_parent()
 
520
        if parent:
 
521
            destination.set_parent(parent)
 
522
 
 
523
 
 
524
class BranchFormat(object):
 
525
    """An encapsulation of the initialization and open routines for a format.
 
526
 
 
527
    Formats provide three things:
 
528
     * An initialization routine,
 
529
     * a format string,
 
530
     * an open routine.
 
531
 
 
532
    Formats are placed in an dict by their format string for reference 
 
533
    during branch opening. Its not required that these be instances, they
 
534
    can be classes themselves with class methods - it simply depends on 
 
535
    whether state is needed for a given format or not.
 
536
 
 
537
    Once a format is deprecated, just deprecate the initialize and open
 
538
    methods on the format class. Do not deprecate the object, as the 
 
539
    object will be created every time regardless.
 
540
    """
 
541
 
 
542
    _default_format = None
 
543
    """The default format used for new branches."""
 
544
 
 
545
    _formats = {}
 
546
    """The known formats."""
 
547
 
 
548
    @classmethod
 
549
    def find_format(klass, a_bzrdir):
 
550
        """Return the format for the branch object in a_bzrdir."""
 
551
        try:
 
552
            transport = a_bzrdir.get_branch_transport(None)
 
553
            format_string = transport.get("format").read()
 
554
            return klass._formats[format_string]
 
555
        except NoSuchFile:
 
556
            raise NotBranchError(path=transport.base)
 
557
        except KeyError:
 
558
            raise errors.UnknownFormatError(format_string)
 
559
 
 
560
    @classmethod
 
561
    def get_default_format(klass):
 
562
        """Return the current default format."""
 
563
        return klass._default_format
 
564
 
 
565
    def get_format_string(self):
 
566
        """Return the ASCII format string that identifies this format."""
 
567
        raise NotImplementedError(self.get_format_string)
 
568
 
 
569
    def initialize(self, a_bzrdir):
 
570
        """Create a branch of this format in a_bzrdir."""
 
571
        raise NotImplementedError(self.initialized)
 
572
 
 
573
    def is_supported(self):
 
574
        """Is this format supported?
 
575
 
 
576
        Supported formats can be initialized and opened.
 
577
        Unsupported formats may not support initialization or committing or 
 
578
        some other features depending on the reason for not being supported.
 
579
        """
 
580
        return True
 
581
 
 
582
    def open(self, a_bzrdir, _found=False):
 
583
        """Return the branch object for a_bzrdir
 
584
 
 
585
        _found is a private parameter, do not use it. It is used to indicate
 
586
               if format probing has already be done.
 
587
        """
 
588
        raise NotImplementedError(self.open)
 
589
 
 
590
    @classmethod
 
591
    def register_format(klass, format):
 
592
        klass._formats[format.get_format_string()] = format
 
593
 
 
594
    @classmethod
 
595
    def set_default_format(klass, format):
 
596
        klass._default_format = format
 
597
 
 
598
    @classmethod
 
599
    def unregister_format(klass, format):
 
600
        assert klass._formats[format.get_format_string()] is format
 
601
        del klass._formats[format.get_format_string()]
 
602
 
 
603
    def __str__(self):
 
604
        return self.get_format_string().rstrip()
 
605
 
 
606
 
 
607
class BzrBranchFormat4(BranchFormat):
 
608
    """Bzr branch format 4.
 
609
 
 
610
    This format has:
 
611
     - a revision-history file.
 
612
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
613
    """
 
614
 
 
615
    def initialize(self, a_bzrdir):
 
616
        """Create a branch of this format in a_bzrdir."""
 
617
        mutter('creating branch in %s', a_bzrdir.transport.base)
 
618
        branch_transport = a_bzrdir.get_branch_transport(self)
 
619
        utf8_files = [('revision-history', ''),
 
620
                      ('branch-name', ''),
 
621
                      ]
 
622
        control_files = LockableFiles(branch_transport, 'branch-lock',
 
623
                                      TransportLock)
 
624
        control_files.create_lock()
 
625
        control_files.lock_write()
 
626
        try:
 
627
            for file, content in utf8_files:
 
628
                control_files.put_utf8(file, content)
 
629
        finally:
 
630
            control_files.unlock()
 
631
        return self.open(a_bzrdir, _found=True)
 
632
 
 
633
    def __init__(self):
 
634
        super(BzrBranchFormat4, self).__init__()
 
635
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
636
 
 
637
    def open(self, a_bzrdir, _found=False):
 
638
        """Return the branch object for a_bzrdir
 
639
 
 
640
        _found is a private parameter, do not use it. It is used to indicate
 
641
               if format probing has already be done.
 
642
        """
 
643
        if not _found:
 
644
            # we are being called directly and must probe.
 
645
            raise NotImplementedError
 
646
        return BzrBranch(_format=self,
 
647
                         _control_files=a_bzrdir._control_files,
 
648
                         a_bzrdir=a_bzrdir,
 
649
                         _repository=a_bzrdir.open_repository())
 
650
 
 
651
    def __str__(self):
 
652
        return "Bazaar-NG branch format 4"
 
653
 
 
654
 
 
655
class BzrBranchFormat5(BranchFormat):
 
656
    """Bzr branch format 5.
 
657
 
 
658
    This format has:
 
659
     - a revision-history file.
 
660
     - a format string
 
661
     - a lock dir guarding the branch itself
 
662
     - all of this stored in a branch/ subdirectory
 
663
     - works with shared repositories.
 
664
 
 
665
    This format is new in bzr 0.8.
 
666
    """
 
667
 
 
668
    def get_format_string(self):
 
669
        """See BranchFormat.get_format_string()."""
 
670
        return "Bazaar-NG branch format 5\n"
 
671
        
 
672
    def initialize(self, a_bzrdir):
 
673
        """Create a branch of this format in a_bzrdir."""
 
674
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
675
        branch_transport = a_bzrdir.get_branch_transport(self)
 
676
        utf8_files = [('revision-history', ''),
 
677
                      ('branch-name', ''),
 
678
                      ]
 
679
        control_files = LockableFiles(branch_transport, 'lock', LockDir)
 
680
        control_files.create_lock()
 
681
        control_files.lock_write()
 
682
        control_files.put_utf8('format', self.get_format_string())
 
683
        try:
 
684
            for file, content in utf8_files:
 
685
                control_files.put_utf8(file, content)
 
686
        finally:
 
687
            control_files.unlock()
 
688
        return self.open(a_bzrdir, _found=True, )
 
689
 
 
690
    def __init__(self):
 
691
        super(BzrBranchFormat5, self).__init__()
 
692
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
693
 
 
694
    def open(self, a_bzrdir, _found=False):
 
695
        """Return the branch object for a_bzrdir
 
696
 
 
697
        _found is a private parameter, do not use it. It is used to indicate
 
698
               if format probing has already be done.
 
699
        """
 
700
        if not _found:
 
701
            format = BranchFormat.find_format(a_bzrdir)
 
702
            assert format.__class__ == self.__class__
 
703
        transport = a_bzrdir.get_branch_transport(None)
 
704
        control_files = LockableFiles(transport, 'lock', LockDir)
 
705
        return BzrBranch5(_format=self,
 
706
                          _control_files=control_files,
 
707
                          a_bzrdir=a_bzrdir,
 
708
                          _repository=a_bzrdir.find_repository())
 
709
 
 
710
    def __str__(self):
 
711
        return "Bazaar-NG Metadir branch format 5"
 
712
 
 
713
 
 
714
class BranchReferenceFormat(BranchFormat):
 
715
    """Bzr branch reference format.
 
716
 
 
717
    Branch references are used in implementing checkouts, they
 
718
    act as an alias to the real branch which is at some other url.
 
719
 
 
720
    This format has:
 
721
     - A location file
 
722
     - a format string
 
723
    """
 
724
 
 
725
    def get_format_string(self):
 
726
        """See BranchFormat.get_format_string()."""
 
727
        return "Bazaar-NG Branch Reference Format 1\n"
 
728
        
 
729
    def initialize(self, a_bzrdir, target_branch=None):
 
730
        """Create a branch of this format in a_bzrdir."""
 
731
        if target_branch is None:
 
732
            # this format does not implement branch itself, thus the implicit
 
733
            # creation contract must see it as uninitializable
 
734
            raise errors.UninitializableFormat(self)
 
735
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
736
        branch_transport = a_bzrdir.get_branch_transport(self)
 
737
        # FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
 
738
        branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
 
739
        branch_transport.put('format', StringIO(self.get_format_string()))
 
740
        return self.open(a_bzrdir, _found=True)
 
741
 
 
742
    def __init__(self):
 
743
        super(BranchReferenceFormat, self).__init__()
 
744
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
745
 
 
746
    def _make_reference_clone_function(format, a_branch):
 
747
        """Create a clone() routine for a branch dynamically."""
 
748
        def clone(to_bzrdir, revision_id=None):
 
749
            """See Branch.clone()."""
 
750
            return format.initialize(to_bzrdir, a_branch)
 
751
            # cannot obey revision_id limits when cloning a reference ...
 
752
            # FIXME RBC 20060210 either nuke revision_id for clone, or
 
753
            # emit some sort of warning/error to the caller ?!
 
754
        return clone
 
755
 
 
756
    def open(self, a_bzrdir, _found=False):
 
757
        """Return the branch that the branch reference in a_bzrdir points at.
 
758
 
 
759
        _found is a private parameter, do not use it. It is used to indicate
 
760
               if format probing has already be done.
 
761
        """
 
762
        if not _found:
 
763
            format = BranchFormat.find_format(a_bzrdir)
 
764
            assert format.__class__ == self.__class__
 
765
        transport = a_bzrdir.get_branch_transport(None)
 
766
        real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
 
767
        result = real_bzrdir.open_branch()
 
768
        # this changes the behaviour of result.clone to create a new reference
 
769
        # rather than a copy of the content of the branch.
 
770
        # I did not use a proxy object because that needs much more extensive
 
771
        # testing, and we are only changing one behaviour at the moment.
 
772
        # If we decide to alter more behaviours - i.e. the implicit nickname
 
773
        # then this should be refactored to introduce a tested proxy branch
 
774
        # and a subclass of that for use in overriding clone() and ....
 
775
        # - RBC 20060210
 
776
        result.clone = self._make_reference_clone_function(result)
 
777
        return result
 
778
 
 
779
 
 
780
# formats which have no format string are not discoverable
 
781
# and not independently creatable, so are not registered.
 
782
__default_format = BzrBranchFormat5()
 
783
BranchFormat.register_format(__default_format)
 
784
BranchFormat.register_format(BranchReferenceFormat())
 
785
BranchFormat.set_default_format(__default_format)
 
786
_legacy_formats = [BzrBranchFormat4(),
 
787
                   ]
 
788
 
 
789
class BzrBranch(Branch):
 
790
    """A branch stored in the actual filesystem.
 
791
 
 
792
    Note that it's "local" in the context of the filesystem; it doesn't
 
793
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
794
    it's writable, and can be accessed via the normal filesystem API.
 
795
    """
 
796
    
 
797
    def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
 
798
                 relax_version_check=DEPRECATED_PARAMETER, _format=None,
 
799
                 _control_files=None, a_bzrdir=None, _repository=None):
 
800
        """Create new branch object at a particular location.
 
801
 
 
802
        transport -- A Transport object, defining how to access files.
 
803
        
 
804
        init -- If True, create new control files in a previously
 
805
             unversioned directory.  If False, the branch must already
 
806
             be versioned.
 
807
 
 
808
        relax_version_check -- If true, the usual check for the branch
 
809
            version is not applied.  This is intended only for
 
810
            upgrade/recovery type use; it's not guaranteed that
 
811
            all operations will work on old format branches.
 
812
        """
 
813
        if a_bzrdir is None:
 
814
            self.bzrdir = bzrdir.BzrDir.open(transport.base)
 
815
        else:
 
816
            self.bzrdir = a_bzrdir
 
817
        self._transport = self.bzrdir.transport.clone('..')
 
818
        self._base = self._transport.base
 
819
        self._format = _format
 
820
        if _control_files is None:
 
821
            raise BzrBadParameterMissing('_control_files')
 
822
        self.control_files = _control_files
 
823
        if deprecated_passed(init):
 
824
            warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
 
825
                 "deprecated as of bzr 0.8. Please use Branch.create().",
 
826
                 DeprecationWarning,
 
827
                 stacklevel=2)
 
828
            if init:
 
829
                # this is slower than before deprecation, oh well never mind.
 
830
                # -> its deprecated.
 
831
                self._initialize(transport.base)
 
832
        self._check_format(_format)
 
833
        if deprecated_passed(relax_version_check):
 
834
            warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
 
835
                 "relax_version_check parameter is deprecated as of bzr 0.8. "
 
836
                 "Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
 
837
                 "open() method.",
 
838
                 DeprecationWarning,
 
839
                 stacklevel=2)
 
840
            if (not relax_version_check
 
841
                and not self._format.is_supported()):
 
842
                raise errors.UnsupportedFormatError(
 
843
                        'sorry, branch format %r not supported' % fmt,
 
844
                        ['use a different bzr version',
 
845
                         'or remove the .bzr directory'
 
846
                         ' and "bzr init" again'])
 
847
        if deprecated_passed(transport):
 
848
            warn("BzrBranch.__init__(transport=XXX...): The transport "
 
849
                 "parameter is deprecated as of bzr 0.8. "
 
850
                 "Please use Branch.open, or bzrdir.open_branch().",
 
851
                 DeprecationWarning,
 
852
                 stacklevel=2)
 
853
        self.repository = _repository
 
854
 
 
855
    def __str__(self):
 
856
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
857
 
 
858
    __repr__ = __str__
 
859
 
998
860
    def __del__(self):
999
 
        self.destroy()
1000
 
 
1001
 
    def destroy(self):
1002
 
        """Destroy the test branch, removing the scratch directory."""
1003
 
        try:
1004
 
            if self.base:
1005
 
                mutter("delete ScratchBranch %s" % self.base)
1006
 
                shutil.rmtree(self.base)
1007
 
        except OSError, e:
1008
 
            # Work around for shutil.rmtree failing on Windows when
1009
 
            # readonly files are encountered
1010
 
            mutter("hit exception in destroying ScratchBranch: %s" % e)
1011
 
            for root, dirs, files in os.walk(self.base, topdown=False):
1012
 
                for name in files:
1013
 
                    os.chmod(os.path.join(root, name), 0700)
1014
 
            shutil.rmtree(self.base)
1015
 
        self.base = None
1016
 
 
 
861
        # TODO: It might be best to do this somewhere else,
 
862
        # but it is nice for a Branch object to automatically
 
863
        # cache it's information.
 
864
        # Alternatively, we could have the Transport objects cache requests
 
865
        # See the earlier discussion about how major objects (like Branch)
 
866
        # should never expect their __del__ function to run.
 
867
        # XXX: cache_root seems to be unused, 2006-01-13 mbp
 
868
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
869
            try:
 
870
                shutil.rmtree(self.cache_root)
 
871
            except:
 
872
                pass
 
873
            self.cache_root = None
 
874
 
 
875
    def _get_base(self):
 
876
        return self._base
 
877
 
 
878
    base = property(_get_base, doc="The URL for the root of this branch.")
 
879
 
 
880
    def _finish_transaction(self):
 
881
        """Exit the current transaction."""
 
882
        return self.control_files._finish_transaction()
 
883
 
 
884
    def get_transaction(self):
 
885
        """Return the current active transaction.
 
886
 
 
887
        If no transaction is active, this returns a passthrough object
 
888
        for which all data is immediately flushed and no caching happens.
 
889
        """
 
890
        # this is an explicit function so that we can do tricky stuff
 
891
        # when the storage in rev_storage is elsewhere.
 
892
        # we probably need to hook the two 'lock a location' and 
 
893
        # 'have a transaction' together more delicately, so that
 
894
        # we can have two locks (branch and storage) and one transaction
 
895
        # ... and finishing the transaction unlocks both, but unlocking
 
896
        # does not. - RBC 20051121
 
897
        return self.control_files.get_transaction()
 
898
 
 
899
    def _set_transaction(self, transaction):
 
900
        """Set a new active transaction."""
 
901
        return self.control_files._set_transaction(transaction)
 
902
 
 
903
    def abspath(self, name):
 
904
        """See Branch.abspath."""
 
905
        return self.control_files._transport.abspath(name)
 
906
 
 
907
    def _check_format(self, format):
 
908
        """Identify the branch format if needed.
 
909
 
 
910
        The format is stored as a reference to the format object in
 
911
        self._format for code that needs to check it later.
 
912
 
 
913
        The format parameter is either None or the branch format class
 
914
        used to open this branch.
 
915
 
 
916
        FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
 
917
        """
 
918
        if format is None:
 
919
            format = BzrBranchFormat.find_format(self.bzrdir)
 
920
        self._format = format
 
921
        mutter("got branch format %s", self._format)
 
922
 
 
923
    @needs_read_lock
 
924
    def get_root_id(self):
 
925
        """See Branch.get_root_id."""
 
926
        tree = self.repository.revision_tree(self.last_revision())
 
927
        return tree.inventory.root.file_id
 
928
 
 
929
    def lock_write(self):
 
930
        # TODO: test for failed two phase locks. This is known broken.
 
931
        self.control_files.lock_write()
 
932
        self.repository.lock_write()
 
933
 
 
934
    def lock_read(self):
 
935
        # TODO: test for failed two phase locks. This is known broken.
 
936
        self.control_files.lock_read()
 
937
        self.repository.lock_read()
 
938
 
 
939
    def unlock(self):
 
940
        # TODO: test for failed two phase locks. This is known broken.
 
941
        self.repository.unlock()
 
942
        self.control_files.unlock()
 
943
        
 
944
    def peek_lock_mode(self):
 
945
        if self.control_files._lock_count == 0:
 
946
            return None
 
947
        else:
 
948
            return self.control_files._lock_mode
 
949
 
 
950
    @needs_read_lock
 
951
    def print_file(self, file, revision_id):
 
952
        """See Branch.print_file."""
 
953
        return self.repository.print_file(file, revision_id)
 
954
 
 
955
    @needs_write_lock
 
956
    def append_revision(self, *revision_ids):
 
957
        """See Branch.append_revision."""
 
958
        for revision_id in revision_ids:
 
959
            mutter("add {%s} to revision-history" % revision_id)
 
960
        rev_history = self.revision_history()
 
961
        rev_history.extend(revision_ids)
 
962
        self.set_revision_history(rev_history)
 
963
 
 
964
    @needs_write_lock
 
965
    def set_revision_history(self, rev_history):
 
966
        """See Branch.set_revision_history."""
 
967
        self.control_files.put_utf8(
 
968
            'revision-history', '\n'.join(rev_history))
 
969
        transaction = self.get_transaction()
 
970
        history = transaction.map.find_revision_history()
 
971
        if history is not None:
 
972
            # update the revision history in the identity map.
 
973
            history[:] = list(rev_history)
 
974
            # this call is disabled because revision_history is 
 
975
            # not really an object yet, and the transaction is for objects.
 
976
            # transaction.register_dirty(history)
 
977
        else:
 
978
            transaction.map.add_revision_history(rev_history)
 
979
            # this call is disabled because revision_history is 
 
980
            # not really an object yet, and the transaction is for objects.
 
981
            # transaction.register_clean(history)
 
982
 
 
983
    def get_revision_delta(self, revno):
 
984
        """Return the delta for one revision.
 
985
 
 
986
        The delta is relative to its mainline predecessor, or the
 
987
        empty tree for revision 1.
 
988
        """
 
989
        assert isinstance(revno, int)
 
990
        rh = self.revision_history()
 
991
        if not (1 <= revno <= len(rh)):
 
992
            raise InvalidRevisionNumber(revno)
 
993
 
 
994
        # revno is 1-based; list is 0-based
 
995
 
 
996
        new_tree = self.repository.revision_tree(rh[revno-1])
 
997
        if revno == 1:
 
998
            old_tree = EmptyTree()
 
999
        else:
 
1000
            old_tree = self.repository.revision_tree(rh[revno-2])
 
1001
        return compare_trees(old_tree, new_tree)
 
1002
 
 
1003
    @needs_read_lock
 
1004
    def revision_history(self):
 
1005
        """See Branch.revision_history."""
 
1006
        transaction = self.get_transaction()
 
1007
        history = transaction.map.find_revision_history()
 
1008
        if history is not None:
 
1009
            mutter("cache hit for revision-history in %s", self)
 
1010
            return list(history)
 
1011
        history = [l.rstrip('\r\n') for l in
 
1012
                self.control_files.get_utf8('revision-history').readlines()]
 
1013
        transaction.map.add_revision_history(history)
 
1014
        # this call is disabled because revision_history is 
 
1015
        # not really an object yet, and the transaction is for objects.
 
1016
        # transaction.register_clean(history, precious=True)
 
1017
        return list(history)
 
1018
 
 
1019
    def update_revisions(self, other, stop_revision=None):
 
1020
        """See Branch.update_revisions."""
 
1021
        if stop_revision is None:
 
1022
            stop_revision = other.last_revision()
 
1023
        ### Should this be checking is_ancestor instead of revision_history?
 
1024
        if (stop_revision is not None and 
 
1025
            stop_revision in self.revision_history()):
 
1026
            return
 
1027
        self.fetch(other, stop_revision)
 
1028
        pullable_revs = self.pullable_revisions(other, stop_revision)
 
1029
        if len(pullable_revs) > 0:
 
1030
            self.append_revision(*pullable_revs)
 
1031
 
 
1032
    def pullable_revisions(self, other, stop_revision):
 
1033
        other_revno = other.revision_id_to_revno(stop_revision)
 
1034
        try:
 
1035
            return self.missing_revisions(other, other_revno)
 
1036
        except DivergedBranches, e:
 
1037
            try:
 
1038
                pullable_revs = get_intervening_revisions(self.last_revision(),
 
1039
                                                          stop_revision, 
 
1040
                                                          self.repository)
 
1041
                assert self.last_revision() not in pullable_revs
 
1042
                return pullable_revs
 
1043
            except bzrlib.errors.NotAncestor:
 
1044
                if is_ancestor(self.last_revision(), stop_revision, self):
 
1045
                    return []
 
1046
                else:
 
1047
                    raise e
 
1048
        
 
1049
    def basis_tree(self):
 
1050
        """See Branch.basis_tree."""
 
1051
        return self.repository.revision_tree(self.last_revision())
 
1052
 
 
1053
    @deprecated_method(zero_eight)
 
1054
    def working_tree(self):
 
1055
        """Create a Working tree object for this branch."""
 
1056
        from bzrlib.workingtree import WorkingTree
 
1057
        from bzrlib.transport.local import LocalTransport
 
1058
        if (self.base.find('://') != -1 or 
 
1059
            not isinstance(self._transport, LocalTransport)):
 
1060
            raise NoWorkingTree(self.base)
 
1061
        return self.bzrdir.open_workingtree()
 
1062
 
 
1063
    @needs_write_lock
 
1064
    def pull(self, source, overwrite=False, stop_revision=None):
 
1065
        """See Branch.pull."""
 
1066
        source.lock_read()
 
1067
        try:
 
1068
            old_count = len(self.revision_history())
 
1069
            try:
 
1070
                self.update_revisions(source,stop_revision)
 
1071
            except DivergedBranches:
 
1072
                if not overwrite:
 
1073
                    raise
 
1074
            if overwrite:
 
1075
                self.set_revision_history(source.revision_history())
 
1076
            new_count = len(self.revision_history())
 
1077
            return new_count - old_count
 
1078
        finally:
 
1079
            source.unlock()
 
1080
 
 
1081
    def get_parent(self):
 
1082
        """See Branch.get_parent."""
 
1083
        import errno
 
1084
        _locs = ['parent', 'pull', 'x-pull']
 
1085
        for l in _locs:
 
1086
            try:
 
1087
                return self.control_files.get_utf8(l).read().strip('\n')
 
1088
            except NoSuchFile:
 
1089
                pass
 
1090
        return None
 
1091
 
 
1092
    def get_push_location(self):
 
1093
        """See Branch.get_push_location."""
 
1094
        config = bzrlib.config.BranchConfig(self)
 
1095
        push_loc = config.get_user_option('push_location')
 
1096
        return push_loc
 
1097
 
 
1098
    def set_push_location(self, location):
 
1099
        """See Branch.set_push_location."""
 
1100
        config = bzrlib.config.LocationConfig(self.base)
 
1101
        config.set_user_option('push_location', location)
 
1102
 
 
1103
    @needs_write_lock
 
1104
    def set_parent(self, url):
 
1105
        """See Branch.set_parent."""
 
1106
        # TODO: Maybe delete old location files?
 
1107
        # URLs should never be unicode, even on the local fs,
 
1108
        # FIXUP this and get_parent in a future branch format bump:
 
1109
        # read and rewrite the file, and have the new format code read
 
1110
        # using .get not .get_utf8. RBC 20060125
 
1111
        self.control_files.put_utf8('parent', url + '\n')
 
1112
 
 
1113
    def tree_config(self):
 
1114
        return TreeConfig(self)
 
1115
 
 
1116
 
 
1117
class BzrBranch5(BzrBranch):
 
1118
    """A format 5 branch. This supports new features over plan branches.
 
1119
 
 
1120
    It has support for a master_branch which is the data for bound branches.
 
1121
    """
 
1122
 
 
1123
    def __init__(self,
 
1124
                 _format,
 
1125
                 _control_files,
 
1126
                 a_bzrdir,
 
1127
                 _repository):
 
1128
        super(BzrBranch5, self).__init__(_format=_format,
 
1129
                                         _control_files=_control_files,
 
1130
                                         a_bzrdir=a_bzrdir,
 
1131
                                         _repository=_repository)
 
1132
        
 
1133
    @needs_write_lock
 
1134
    def pull(self, source, overwrite=False, stop_revision=None):
 
1135
        """Updates branch.pull to be bound branch aware."""
 
1136
        bound_location = self.get_bound_location()
 
1137
        if source.base != bound_location:
 
1138
            # not pulling from master, so we need to update master.
 
1139
            master_branch = self.get_master_branch()
 
1140
            if master_branch:
 
1141
                master_branch.pull(source)
 
1142
                source = master_branch
 
1143
        return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
 
1144
 
 
1145
    def get_bound_location(self):
 
1146
        try:
 
1147
            return self.control_files.get_utf8('bound').read()[:-1]
 
1148
        except errors.NoSuchFile:
 
1149
            return None
 
1150
 
 
1151
    @needs_read_lock
 
1152
    def get_master_branch(self):
 
1153
        """Return the branch we are bound to.
 
1154
        
 
1155
        :return: Either a Branch, or None
 
1156
 
 
1157
        This could memoise the branch, but if thats done
 
1158
        it must be revalidated on each new lock.
 
1159
        So for now we just dont memoise it.
 
1160
        # RBC 20060304 review this decision.
 
1161
        """
 
1162
        bound_loc = self.get_bound_location()
 
1163
        if not bound_loc:
 
1164
            return None
 
1165
        try:
 
1166
            return Branch.open(bound_loc)
 
1167
        except (errors.NotBranchError, errors.ConnectionError), e:
 
1168
            raise errors.BoundBranchConnectionFailure(
 
1169
                    self, bound_loc, e)
 
1170
 
 
1171
    @needs_write_lock
 
1172
    def set_bound_location(self, location):
 
1173
        """Set the target where this branch is bound to.
 
1174
 
 
1175
        :param location: URL to the target branch
 
1176
        """
 
1177
        if location:
 
1178
            self.control_files.put_utf8('bound', location+'\n')
 
1179
        else:
 
1180
            try:
 
1181
                self.control_files._transport.delete('bound')
 
1182
            except NoSuchFile:
 
1183
                return False
 
1184
            return True
 
1185
 
 
1186
    @needs_write_lock
 
1187
    def bind(self, other):
 
1188
        """Bind the local branch the other branch.
 
1189
 
 
1190
        :param other: The branch to bind to
 
1191
        :type other: Branch
 
1192
        """
 
1193
        # TODO: jam 20051230 Consider checking if the target is bound
 
1194
        #       It is debatable whether you should be able to bind to
 
1195
        #       a branch which is itself bound.
 
1196
        #       Committing is obviously forbidden,
 
1197
        #       but binding itself may not be.
 
1198
        #       Since we *have* to check at commit time, we don't
 
1199
        #       *need* to check here
 
1200
        self.pull(other)
 
1201
 
 
1202
        # we are now equal to or a suffix of other.
 
1203
 
 
1204
        # Since we have 'pulled' from the remote location,
 
1205
        # now we should try to pull in the opposite direction
 
1206
        # in case the local tree has more revisions than the
 
1207
        # remote one.
 
1208
        # There may be a different check you could do here
 
1209
        # rather than actually trying to install revisions remotely.
 
1210
        # TODO: capture an exception which indicates the remote branch
 
1211
        #       is not writeable. 
 
1212
        #       If it is up-to-date, this probably should not be a failure
 
1213
        
 
1214
        # lock other for write so the revision-history syncing cannot race
 
1215
        other.lock_write()
 
1216
        try:
 
1217
            other.pull(self)
 
1218
            # if this does not error, other now has the same last rev we do
 
1219
            # it can only error if the pull from other was concurrent with
 
1220
            # a commit to other from someone else.
 
1221
 
 
1222
            # until we ditch revision-history, we need to sync them up:
 
1223
            self.set_revision_history(other.revision_history())
 
1224
            # now other and self are up to date with each other and have the
 
1225
            # same revision-history.
 
1226
        finally:
 
1227
            other.unlock()
 
1228
 
 
1229
        self.set_bound_location(other.base)
 
1230
 
 
1231
    @needs_write_lock
 
1232
    def unbind(self):
 
1233
        """If bound, unbind"""
 
1234
        return self.set_bound_location(None)
 
1235
 
 
1236
    @needs_write_lock
 
1237
    def update(self):
 
1238
        """Synchronise this branch with the master branch if any. 
 
1239
 
 
1240
        :return: None or the last_revision that was pivoted out during the
 
1241
                 update.
 
1242
        """
 
1243
        master = self.get_master_branch()
 
1244
        if master is not None:
 
1245
            old_tip = self.last_revision()
 
1246
            self.pull(master, overwrite=True)
 
1247
            if old_tip in self.repository.get_ancestry(self.last_revision()):
 
1248
                return None
 
1249
            return old_tip
 
1250
        return None
 
1251
 
 
1252
 
 
1253
class BranchTestProviderAdapter(object):
 
1254
    """A tool to generate a suite testing multiple branch formats at once.
 
1255
 
 
1256
    This is done by copying the test once for each transport and injecting
 
1257
    the transport_server, transport_readonly_server, and branch_format
 
1258
    classes into each copy. Each copy is also given a new id() to make it
 
1259
    easy to identify.
 
1260
    """
 
1261
 
 
1262
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1263
        self._transport_server = transport_server
 
1264
        self._transport_readonly_server = transport_readonly_server
 
1265
        self._formats = formats
1017
1266
    
 
1267
    def adapt(self, test):
 
1268
        result = TestSuite()
 
1269
        for branch_format, bzrdir_format in self._formats:
 
1270
            new_test = deepcopy(test)
 
1271
            new_test.transport_server = self._transport_server
 
1272
            new_test.transport_readonly_server = self._transport_readonly_server
 
1273
            new_test.bzrdir_format = bzrdir_format
 
1274
            new_test.branch_format = branch_format
 
1275
            def make_new_test_id():
 
1276
                new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
 
1277
                return lambda: new_id
 
1278
            new_test.id = make_new_test_id()
 
1279
            result.addTest(new_test)
 
1280
        return result
 
1281
 
1018
1282
 
1019
1283
######################################################################
1020
1284
# predicates
1021
1285
 
1022
1286
 
1023
 
def is_control_file(filename):
1024
 
    ## FIXME: better check
1025
 
    filename = os.path.normpath(filename)
1026
 
    while filename != '':
1027
 
        head, tail = os.path.split(filename)
1028
 
        ## mutter('check %r for control file' % ((head, tail), ))
1029
 
        if tail == bzrlib.BZRDIR:
1030
 
            return True
1031
 
        if filename == head:
1032
 
            break
1033
 
        filename = head
1034
 
    return False
1035
 
 
1036
 
 
1037
 
 
1038
 
def gen_file_id(name):
1039
 
    """Return new file id.
1040
 
 
1041
 
    This should probably generate proper UUIDs, but for the moment we
1042
 
    cope with just randomness because running uuidgen every time is
1043
 
    slow."""
1044
 
    import re
1045
 
 
1046
 
    # get last component
1047
 
    idx = name.rfind('/')
1048
 
    if idx != -1:
1049
 
        name = name[idx+1 : ]
1050
 
    idx = name.rfind('\\')
1051
 
    if idx != -1:
1052
 
        name = name[idx+1 : ]
1053
 
 
1054
 
    # make it not a hidden file
1055
 
    name = name.lstrip('.')
1056
 
 
1057
 
    # remove any wierd characters; we don't escape them but rather
1058
 
    # just pull them out
1059
 
    name = re.sub(r'[^\w.]', '', name)
1060
 
 
1061
 
    s = hexlify(rand_bytes(8))
1062
 
    return '-'.join((name, compact_date(time.time()), s))
 
1287
@deprecated_function(zero_eight)
 
1288
def ScratchBranch(*args, **kwargs):
 
1289
    """See bzrlib.bzrdir.ScratchDir."""
 
1290
    d = ScratchDir(*args, **kwargs)
 
1291
    return d.open_branch()
 
1292
 
 
1293
 
 
1294
@deprecated_function(zero_eight)
 
1295
def is_control_file(*args, **kwargs):
 
1296
    """See bzrlib.workingtree.is_control_file."""
 
1297
    return bzrlib.workingtree.is_control_file(*args, **kwargs)