~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-30 02:45:48 UTC
  • Revision ID: mbp@sourcefrog.net-20050530024548-120dad7e43de5fec
- rsync upload should be quieter

Show diffs side-by-side

added added

removed removed

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