~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-06-27 01:39:26 UTC
  • Revision ID: mbp@sourcefrog.net-20050627013926-49413d5928809350
- import effbot.org http client

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 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 cStringIO import StringIO
19
 
 
20
 
from bzrlib.lazy_import import lazy_import
21
 
lazy_import(globals(), """
22
 
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
23
21
 
24
22
import bzrlib
25
 
from bzrlib import (
26
 
        bzrdir,
27
 
        cache_utf8,
28
 
        config as _mod_config,
29
 
        errors,
30
 
        lockdir,
31
 
        lockable_files,
32
 
        osutils,
33
 
        revision as _mod_revision,
34
 
        transport,
35
 
        tree,
36
 
        tsort,
37
 
        ui,
38
 
        urlutils,
39
 
        )
40
 
from bzrlib.config import BranchConfig, TreeConfig
41
 
from bzrlib.lockable_files import LockableFiles, TransportLock
42
 
from bzrlib.tag import (
43
 
    BasicTags,
44
 
    DisabledTags,
45
 
    )
46
 
""")
47
 
 
48
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
 
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
 
                           HistoryMissing, InvalidRevisionId,
51
 
                           InvalidRevisionNumber, LockError, NoSuchFile,
52
 
                           NoSuchRevision, NoWorkingTree, NotVersionedError,
53
 
                           NotBranchError, UninitializableFormat,
54
 
                           UnlistableStore, UnlistableBranch,
55
 
                           )
56
 
from bzrlib.hooks import Hooks
57
 
from bzrlib.symbol_versioning import (deprecated_function,
58
 
                                      deprecated_method,
59
 
                                      DEPRECATED_PARAMETER,
60
 
                                      deprecated_passed,
61
 
                                      zero_eight, zero_nine, zero_sixteen,
62
 
                                      )
63
 
from bzrlib.trace import mutter, note
64
 
 
65
 
 
66
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
69
 
 
70
 
 
71
 
# TODO: Maybe include checks for common corruption of newlines, etc?
72
 
 
73
 
# TODO: Some operations like log might retrieve the same revisions
74
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
75
 
# cache in memory to make this faster.  In general anything can be
76
 
# cached in memory between lock and unlock operations. .. nb thats
77
 
# 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_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
def find_cached_branch(f, cache_root, **args):
 
49
    from remotebranch import RemoteBranch
 
50
    br = find_branch(f, **args)
 
51
    def cacheify(br, store_name):
 
52
        from meta_store import CachedStore
 
53
        cache_path = os.path.join(cache_root, store_name)
 
54
        os.mkdir(cache_path)
 
55
        new_store = CachedStore(getattr(br, store_name), cache_path)
 
56
        setattr(br, store_name, new_store)
 
57
 
 
58
    if isinstance(br, RemoteBranch):
 
59
        cacheify(br, 'inventory_store')
 
60
        cacheify(br, 'text_store')
 
61
        cacheify(br, 'revision_store')
 
62
    return br
 
63
 
 
64
 
 
65
def _relpath(base, path):
 
66
    """Return path relative to base, or raise exception.
 
67
 
 
68
    The path may be either an absolute path or a path relative to the
 
69
    current working directory.
 
70
 
 
71
    Lifted out of Branch.relpath for ease of testing.
 
72
 
 
73
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
74
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
75
    avoids that problem."""
 
76
    rp = os.path.abspath(path)
 
77
 
 
78
    s = []
 
79
    head = rp
 
80
    while len(head) >= len(base):
 
81
        if head == base:
 
82
            break
 
83
        head, tail = os.path.split(head)
 
84
        if tail:
 
85
            s.insert(0, tail)
 
86
    else:
 
87
        from errors import NotBranchError
 
88
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
89
 
 
90
    return os.sep.join(s)
 
91
        
 
92
 
 
93
def find_branch_root(f=None):
 
94
    """Find the branch root enclosing f, or pwd.
 
95
 
 
96
    f may be a filename or a URL.
 
97
 
 
98
    It is not necessary that f exists.
 
99
 
 
100
    Basically we keep looking up until we find the control directory or
 
101
    run into the root."""
 
102
    if f == None:
 
103
        f = os.getcwd()
 
104
    elif hasattr(os.path, 'realpath'):
 
105
        f = os.path.realpath(f)
 
106
    else:
 
107
        f = os.path.abspath(f)
 
108
    if not os.path.exists(f):
 
109
        raise BzrError('%r does not exist' % f)
 
110
        
 
111
 
 
112
    orig_f = f
 
113
 
 
114
    while True:
 
115
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
116
            return f
 
117
        head, tail = os.path.split(f)
 
118
        if head == f:
 
119
            # reached the root, whatever that may be
 
120
            raise BzrError('%r is not in a branch' % orig_f)
 
121
        f = head
 
122
    
 
123
class DivergedBranches(Exception):
 
124
    def __init__(self, branch1, branch2):
 
125
        self.branch1 = branch1
 
126
        self.branch2 = branch2
 
127
        Exception.__init__(self, "These branches have diverged.")
 
128
 
 
129
 
 
130
class NoSuchRevision(BzrError):
 
131
    def __init__(self, branch, revision):
 
132
        self.branch = branch
 
133
        self.revision = revision
 
134
        msg = "Branch %s has no revision %d" % (branch, revision)
 
135
        BzrError.__init__(self, msg)
78
136
 
79
137
 
80
138
######################################################################
84
142
    """Branch holding a history of revisions.
85
143
 
86
144
    base
87
 
        Base directory/url of the branch.
88
 
 
89
 
    hooks: An instance of BranchHooks.
 
145
        Base directory of the branch.
 
146
 
 
147
    _lock_mode
 
148
        None, or 'r' or 'w'
 
149
 
 
150
    _lock_count
 
151
        If _lock_mode is true, a positive count of the number of times the
 
152
        lock has been taken.
 
153
 
 
154
    _lock
 
155
        Lock object from bzrlib.lock.
90
156
    """
91
 
    # this is really an instance variable - FIXME move it there
92
 
    # - RBC 20060112
93
157
    base = None
94
 
 
95
 
    # override this to set the strategy for storing tags
96
 
    def _make_tags(self):
97
 
        return DisabledTags(self)
98
 
 
99
 
    def __init__(self, *ignored, **ignored_too):
100
 
        self.tags = self._make_tags()
101
 
        self._revision_history_cache = None
102
 
        self._revision_id_to_revno_cache = None
103
 
 
104
 
    def break_lock(self):
105
 
        """Break a lock if one is present from another instance.
106
 
 
107
 
        Uses the ui factory to ask for confirmation if the lock may be from
108
 
        an active process.
109
 
 
110
 
        This will probe the repository for its lock as well.
111
 
        """
112
 
        self.control_files.break_lock()
113
 
        self.repository.break_lock()
114
 
        master = self.get_master_branch()
115
 
        if master is not None:
116
 
            master.break_lock()
117
 
 
118
 
    @staticmethod
119
 
    @deprecated_method(zero_eight)
120
 
    def open_downlevel(base):
121
 
        """Open a branch which may be of an old format."""
122
 
        return Branch.open(base, _unsupported=True)
123
 
 
124
 
    @staticmethod
125
 
    def open(base, _unsupported=False):
126
 
        """Open the branch rooted at base.
127
 
 
128
 
        For instance, if the branch is at URL/.bzr/branch,
129
 
        Branch.open(URL) -> a Branch instance.
130
 
        """
131
 
        control = bzrdir.BzrDir.open(base, _unsupported)
132
 
        return control.open_branch(_unsupported)
133
 
 
134
 
    @staticmethod
135
 
    def open_from_transport(transport, _unsupported=False):
136
 
        """Open the branch rooted at transport"""
137
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
138
 
        return control.open_branch(_unsupported)
139
 
 
140
 
    @staticmethod
141
 
    def open_containing(url, possible_transports=None):
142
 
        """Open an existing branch which contains url.
143
 
        
144
 
        This probes for a branch at url, and searches upwards from there.
145
 
 
146
 
        Basically we keep looking up until we find the control directory or
147
 
        run into the root.  If there isn't one, raises NotBranchError.
148
 
        If there is one and it is either an unrecognised format or an unsupported 
149
 
        format, UnknownFormatError or UnsupportedFormatError are raised.
150
 
        If there is one, it is returned, along with the unused portion of url.
151
 
        """
152
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
153
 
                                                         possible_transports)
154
 
        return control.open_branch(), relpath
155
 
 
156
 
    @staticmethod
157
 
    @deprecated_function(zero_eight)
158
 
    def initialize(base):
159
 
        """Create a new working tree and branch, rooted at 'base' (url)
160
 
 
161
 
        NOTE: This will soon be deprecated in favour of creation
162
 
        through a BzrDir.
163
 
        """
164
 
        return bzrdir.BzrDir.create_standalone_workingtree(base).branch
165
 
 
166
 
    @deprecated_function(zero_eight)
167
 
    def setup_caching(self, cache_root):
168
 
        """Subclasses that care about caching should override this, and set
169
 
        up cached stores located under cache_root.
170
 
        
171
 
        NOTE: This is unused.
172
 
        """
173
 
        pass
174
 
 
175
 
    def get_config(self):
176
 
        return BranchConfig(self)
177
 
 
178
 
    def _get_nick(self):
179
 
        return self.get_config().get_nickname()
180
 
 
181
 
    def _set_nick(self, nick):
182
 
        self.get_config().set_user_option('nickname', nick, warn_masked=True)
183
 
 
184
 
    nick = property(_get_nick, _set_nick)
185
 
 
186
 
    def is_locked(self):
187
 
        raise NotImplementedError(self.is_locked)
 
158
    _lock_mode = None
 
159
    _lock_count = None
 
160
    _lock = None
 
161
    
 
162
    def __init__(self, base, init=False, find_root=True):
 
163
        """Create new branch object at a particular location.
 
164
 
 
165
        base -- Base directory for the branch.
 
166
        
 
167
        init -- If True, create new control files in a previously
 
168
             unversioned directory.  If False, the branch must already
 
169
             be versioned.
 
170
 
 
171
        find_root -- If true and init is false, find the root of the
 
172
             existing branch containing base.
 
173
 
 
174
        In the test suite, creation of new trees is tested using the
 
175
        `ScratchBranch` class.
 
176
        """
 
177
        if init:
 
178
            self.base = os.path.realpath(base)
 
179
            self._make_control()
 
180
        elif find_root:
 
181
            self.base = find_branch_root(base)
 
182
        else:
 
183
            self.base = os.path.realpath(base)
 
184
            if not isdir(self.controlfilename('.')):
 
185
                from errors import NotBranchError
 
186
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
187
                                     ['use "bzr init" to initialize a new working tree',
 
188
                                      'current bzr can only operate from top-of-tree'])
 
189
        self._check_format()
 
190
 
 
191
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
192
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
193
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
194
 
 
195
 
 
196
    def __str__(self):
 
197
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
198
 
 
199
 
 
200
    __repr__ = __str__
 
201
 
 
202
 
 
203
    def __del__(self):
 
204
        if self._lock_mode or self._lock:
 
205
            from warnings import warn
 
206
            warn("branch %r was not explicitly unlocked" % self)
 
207
            self._lock.unlock()
 
208
 
 
209
 
188
210
 
189
211
    def lock_write(self):
190
 
        raise NotImplementedError(self.lock_write)
 
212
        if self._lock_mode:
 
213
            if self._lock_mode != 'w':
 
214
                from errors import LockError
 
215
                raise LockError("can't upgrade to a write lock from %r" %
 
216
                                self._lock_mode)
 
217
            self._lock_count += 1
 
218
        else:
 
219
            from bzrlib.lock import WriteLock
 
220
 
 
221
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
222
            self._lock_mode = 'w'
 
223
            self._lock_count = 1
 
224
 
 
225
 
191
226
 
192
227
    def lock_read(self):
193
 
        raise NotImplementedError(self.lock_read)
194
 
 
 
228
        if self._lock_mode:
 
229
            assert self._lock_mode in ('r', 'w'), \
 
230
                   "invalid lock mode %r" % self._lock_mode
 
231
            self._lock_count += 1
 
232
        else:
 
233
            from bzrlib.lock import ReadLock
 
234
 
 
235
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
236
            self._lock_mode = 'r'
 
237
            self._lock_count = 1
 
238
                        
 
239
 
 
240
            
195
241
    def unlock(self):
196
 
        raise NotImplementedError(self.unlock)
197
 
 
198
 
    def peek_lock_mode(self):
199
 
        """Return lock mode for the Branch: 'r', 'w' or None"""
200
 
        raise NotImplementedError(self.peek_lock_mode)
201
 
 
202
 
    def get_physical_lock_status(self):
203
 
        raise NotImplementedError(self.get_physical_lock_status)
204
 
 
205
 
    @needs_read_lock
206
 
    def get_revision_id_to_revno_map(self):
207
 
        """Return the revision_id => dotted revno map.
208
 
 
209
 
        This will be regenerated on demand, but will be cached.
210
 
 
211
 
        :return: A dictionary mapping revision_id => dotted revno.
212
 
            This dictionary should not be modified by the caller.
213
 
        """
214
 
        if self._revision_id_to_revno_cache is not None:
215
 
            mapping = self._revision_id_to_revno_cache
 
242
        if not self._lock_mode:
 
243
            from errors import LockError
 
244
            raise LockError('branch %r is not locked' % (self))
 
245
 
 
246
        if self._lock_count > 1:
 
247
            self._lock_count -= 1
216
248
        else:
217
 
            mapping = self._gen_revno_map()
218
 
            self._cache_revision_id_to_revno(mapping)
219
 
        # TODO: jam 20070417 Since this is being cached, should we be returning
220
 
        #       a copy?
221
 
        # I would rather not, and instead just declare that users should not
222
 
        # modify the return value.
223
 
        return mapping
224
 
 
225
 
    def _gen_revno_map(self):
226
 
        """Create a new mapping from revision ids to dotted revnos.
227
 
 
228
 
        Dotted revnos are generated based on the current tip in the revision
229
 
        history.
230
 
        This is the worker function for get_revision_id_to_revno_map, which
231
 
        just caches the return value.
232
 
 
233
 
        :return: A dictionary mapping revision_id => dotted revno.
234
 
        """
235
 
        last_revision = self.last_revision()
236
 
        revision_graph = self.repository.get_revision_graph(last_revision)
237
 
        merge_sorted_revisions = tsort.merge_sort(
238
 
            revision_graph,
239
 
            last_revision,
240
 
            None,
241
 
            generate_revno=True)
242
 
        revision_id_to_revno = dict((rev_id, revno)
243
 
                                    for seq_num, rev_id, depth, revno, end_of_merge
244
 
                                     in merge_sorted_revisions)
245
 
        return revision_id_to_revno
246
 
 
247
 
    def leave_lock_in_place(self):
248
 
        """Tell this branch object not to release the physical lock when this
249
 
        object is unlocked.
250
 
        
251
 
        If lock_write doesn't return a token, then this method is not supported.
252
 
        """
253
 
        self.control_files.leave_in_place()
254
 
 
255
 
    def dont_leave_lock_in_place(self):
256
 
        """Tell this branch object to release the physical lock when this
257
 
        object is unlocked, even if it didn't originally acquire it.
258
 
 
259
 
        If lock_write doesn't return a token, then this method is not supported.
260
 
        """
261
 
        self.control_files.dont_leave_in_place()
 
249
            self._lock.unlock()
 
250
            self._lock = None
 
251
            self._lock_mode = self._lock_count = None
 
252
 
262
253
 
263
254
    def abspath(self, name):
264
 
        """Return absolute filename for something in the branch
265
 
        
266
 
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
267
 
        method and not a tree method.
268
 
        """
269
 
        raise NotImplementedError(self.abspath)
270
 
 
271
 
    def bind(self, other):
272
 
        """Bind the local branch the other branch.
273
 
 
274
 
        :param other: The branch to bind to
275
 
        :type other: Branch
276
 
        """
277
 
        raise errors.UpgradeRequired(self.base)
278
 
 
279
 
    @needs_write_lock
280
 
    def fetch(self, from_branch, last_revision=None, pb=None):
281
 
        """Copy revisions from from_branch into this branch.
282
 
 
283
 
        :param from_branch: Where to copy from.
284
 
        :param last_revision: What revision to stop at (None for at the end
285
 
                              of the branch.
286
 
        :param pb: An optional progress bar to use.
287
 
 
288
 
        Returns the copied revision count and the failed revisions in a tuple:
289
 
        (copied, failures).
290
 
        """
291
 
        if self.base == from_branch.base:
292
 
            return (0, [])
293
 
        if pb is None:
294
 
            nested_pb = ui.ui_factory.nested_progress_bar()
295
 
            pb = nested_pb
296
 
        else:
297
 
            nested_pb = None
298
 
 
299
 
        from_branch.lock_read()
300
 
        try:
301
 
            if last_revision is None:
302
 
                pb.update('get source history')
303
 
                last_revision = from_branch.last_revision()
304
 
                if last_revision is None:
305
 
                    last_revision = _mod_revision.NULL_REVISION
306
 
            return self.repository.fetch(from_branch.repository,
307
 
                                         revision_id=last_revision,
308
 
                                         pb=nested_pb)
309
 
        finally:
310
 
            if nested_pb is not None:
311
 
                nested_pb.finished()
312
 
            from_branch.unlock()
313
 
 
314
 
    def get_bound_location(self):
315
 
        """Return the URL of the branch we are bound to.
316
 
 
317
 
        Older format branches cannot bind, please be sure to use a metadir
318
 
        branch.
319
 
        """
320
 
        return None
321
 
    
322
 
    def get_old_bound_location(self):
323
 
        """Return the URL of the branch we used to be bound to
324
 
        """
325
 
        raise errors.UpgradeRequired(self.base)
326
 
 
327
 
    def get_commit_builder(self, parents, config=None, timestamp=None, 
328
 
                           timezone=None, committer=None, revprops=None, 
329
 
                           revision_id=None):
330
 
        """Obtain a CommitBuilder for this branch.
331
 
        
332
 
        :param parents: Revision ids of the parents of the new revision.
333
 
        :param config: Optional configuration to use.
334
 
        :param timestamp: Optional timestamp recorded for commit.
335
 
        :param timezone: Optional timezone for timestamp.
336
 
        :param committer: Optional committer to set for commit.
337
 
        :param revprops: Optional dictionary of revision properties.
338
 
        :param revision_id: Optional revision id.
339
 
        """
340
 
 
341
 
        if config is None:
342
 
            config = self.get_config()
343
 
        
344
 
        return self.repository.get_commit_builder(self, parents, config,
345
 
            timestamp, timezone, committer, revprops, revision_id)
346
 
 
347
 
    def get_master_branch(self):
348
 
        """Return the branch we are bound to.
349
 
        
350
 
        :return: Either a Branch, or None
351
 
        """
352
 
        return None
353
 
 
354
 
    def get_revision_delta(self, revno):
355
 
        """Return the delta for one revision.
356
 
 
357
 
        The delta is relative to its mainline predecessor, or the
358
 
        empty tree for revision 1.
359
 
        """
360
 
        assert isinstance(revno, int)
361
 
        rh = self.revision_history()
362
 
        if not (1 <= revno <= len(rh)):
363
 
            raise InvalidRevisionNumber(revno)
364
 
        return self.repository.get_revision_delta(rh[revno-1])
365
 
 
366
 
    @deprecated_method(zero_sixteen)
367
 
    def get_root_id(self):
368
 
        """Return the id of this branches root
369
 
 
370
 
        Deprecated: branches don't have root ids-- trees do.
371
 
        Use basis_tree().get_root_id() instead.
372
 
        """
373
 
        raise NotImplementedError(self.get_root_id)
374
 
 
375
 
    def print_file(self, file, revision_id):
 
255
        """Return absolute filename for something in the branch"""
 
256
        return os.path.join(self.base, name)
 
257
 
 
258
 
 
259
    def relpath(self, path):
 
260
        """Return path relative to this branch of something inside it.
 
261
 
 
262
        Raises an error if path is not in this branch."""
 
263
        return _relpath(self.base, path)
 
264
 
 
265
 
 
266
    def controlfilename(self, file_or_path):
 
267
        """Return location relative to branch."""
 
268
        if isinstance(file_or_path, types.StringTypes):
 
269
            file_or_path = [file_or_path]
 
270
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
271
 
 
272
 
 
273
    def controlfile(self, file_or_path, mode='r'):
 
274
        """Open a control file for this branch.
 
275
 
 
276
        There are two classes of file in the control directory: text
 
277
        and binary.  binary files are untranslated byte streams.  Text
 
278
        control files are stored with Unix newlines and in UTF-8, even
 
279
        if the platform or locale defaults are different.
 
280
 
 
281
        Controlfiles should almost never be opened in write mode but
 
282
        rather should be atomically copied and replaced using atomicfile.
 
283
        """
 
284
 
 
285
        fn = self.controlfilename(file_or_path)
 
286
 
 
287
        if mode == 'rb' or mode == 'wb':
 
288
            return file(fn, mode)
 
289
        elif mode == 'r' or mode == 'w':
 
290
            # open in binary mode anyhow so there's no newline translation;
 
291
            # codecs uses line buffering by default; don't want that.
 
292
            import codecs
 
293
            return codecs.open(fn, mode + 'b', 'utf-8',
 
294
                               buffering=60000)
 
295
        else:
 
296
            raise BzrError("invalid controlfile mode %r" % mode)
 
297
 
 
298
 
 
299
 
 
300
    def _make_control(self):
 
301
        os.mkdir(self.controlfilename([]))
 
302
        self.controlfile('README', 'w').write(
 
303
            "This is a Bazaar-NG control directory.\n"
 
304
            "Do not change any files in this directory.\n")
 
305
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
306
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
307
            os.mkdir(self.controlfilename(d))
 
308
        for f in ('revision-history', 'merged-patches',
 
309
                  'pending-merged-patches', 'branch-name',
 
310
                  'branch-lock'):
 
311
            self.controlfile(f, 'w').write('')
 
312
        mutter('created control directory in ' + self.base)
 
313
        Inventory().write_xml(self.controlfile('inventory','w'))
 
314
 
 
315
 
 
316
    def _check_format(self):
 
317
        """Check this branch format is supported.
 
318
 
 
319
        The current tool only supports the current unstable format.
 
320
 
 
321
        In the future, we might need different in-memory Branch
 
322
        classes to support downlevel branches.  But not yet.
 
323
        """
 
324
        # This ignores newlines so that we can open branches created
 
325
        # on Windows from Linux and so on.  I think it might be better
 
326
        # to always make all internal files in unix format.
 
327
        fmt = self.controlfile('branch-format', 'r').read()
 
328
        fmt.replace('\r\n', '')
 
329
        if fmt != BZR_BRANCH_FORMAT:
 
330
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
331
                           ['use a different bzr version',
 
332
                            'or remove the .bzr directory and "bzr init" again'])
 
333
 
 
334
 
 
335
 
 
336
    def read_working_inventory(self):
 
337
        """Read the working inventory."""
 
338
        before = time.time()
 
339
        # ElementTree does its own conversion from UTF-8, so open in
 
340
        # binary.
 
341
        self.lock_read()
 
342
        try:
 
343
            inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
344
            mutter("loaded inventory of %d items in %f"
 
345
                   % (len(inv), time.time() - before))
 
346
            return inv
 
347
        finally:
 
348
            self.unlock()
 
349
            
 
350
 
 
351
    def _write_inventory(self, inv):
 
352
        """Update the working inventory.
 
353
 
 
354
        That is to say, the inventory describing changes underway, that
 
355
        will be committed to the next revision.
 
356
        """
 
357
        self.lock_write()
 
358
        try:
 
359
            from bzrlib.atomicfile import AtomicFile
 
360
 
 
361
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
362
            try:
 
363
                inv.write_xml(f)
 
364
                f.commit()
 
365
            finally:
 
366
                f.close()
 
367
        finally:
 
368
            self.unlock()
 
369
        
 
370
        mutter('wrote working inventory')
 
371
            
 
372
 
 
373
    inventory = property(read_working_inventory, _write_inventory, None,
 
374
                         """Inventory for the working copy.""")
 
375
 
 
376
 
 
377
    def add(self, files, verbose=False, ids=None):
 
378
        """Make files versioned.
 
379
 
 
380
        Note that the command line normally calls smart_add instead.
 
381
 
 
382
        This puts the files in the Added state, so that they will be
 
383
        recorded by the next commit.
 
384
 
 
385
        files
 
386
            List of paths to add, relative to the base of the tree.
 
387
 
 
388
        ids
 
389
            If set, use these instead of automatically generated ids.
 
390
            Must be the same length as the list of files, but may
 
391
            contain None for ids that are to be autogenerated.
 
392
 
 
393
        TODO: Perhaps have an option to add the ids even if the files do
 
394
              not (yet) exist.
 
395
 
 
396
        TODO: Perhaps return the ids of the files?  But then again it
 
397
              is easy to retrieve them if they're needed.
 
398
 
 
399
        TODO: Adding a directory should optionally recurse down and
 
400
              add all non-ignored children.  Perhaps do that in a
 
401
              higher-level method.
 
402
        """
 
403
        # TODO: Re-adding a file that is removed in the working copy
 
404
        # should probably put it back with the previous ID.
 
405
        if isinstance(files, types.StringTypes):
 
406
            assert(ids is None or isinstance(ids, types.StringTypes))
 
407
            files = [files]
 
408
            if ids is not None:
 
409
                ids = [ids]
 
410
 
 
411
        if ids is None:
 
412
            ids = [None] * len(files)
 
413
        else:
 
414
            assert(len(ids) == len(files))
 
415
 
 
416
        self.lock_write()
 
417
        try:
 
418
            inv = self.read_working_inventory()
 
419
            for f,file_id in zip(files, ids):
 
420
                if is_control_file(f):
 
421
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
422
 
 
423
                fp = splitpath(f)
 
424
 
 
425
                if len(fp) == 0:
 
426
                    raise BzrError("cannot add top-level %r" % f)
 
427
 
 
428
                fullpath = os.path.normpath(self.abspath(f))
 
429
 
 
430
                try:
 
431
                    kind = file_kind(fullpath)
 
432
                except OSError:
 
433
                    # maybe something better?
 
434
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
435
 
 
436
                if kind != 'file' and kind != 'directory':
 
437
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
438
 
 
439
                if file_id is None:
 
440
                    file_id = gen_file_id(f)
 
441
                inv.add_path(f, kind=kind, file_id=file_id)
 
442
 
 
443
                if verbose:
 
444
                    print 'added', quotefn(f)
 
445
 
 
446
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
447
 
 
448
            self._write_inventory(inv)
 
449
        finally:
 
450
            self.unlock()
 
451
            
 
452
 
 
453
    def print_file(self, file, revno):
376
454
        """Print `file` to stdout."""
377
 
        raise NotImplementedError(self.print_file)
378
 
 
379
 
    def append_revision(self, *revision_ids):
380
 
        raise NotImplementedError(self.append_revision)
381
 
 
382
 
    def set_revision_history(self, rev_history):
383
 
        raise NotImplementedError(self.set_revision_history)
384
 
 
385
 
    def _cache_revision_history(self, rev_history):
386
 
        """Set the cached revision history to rev_history.
387
 
 
388
 
        The revision_history method will use this cache to avoid regenerating
389
 
        the revision history.
390
 
 
391
 
        This API is semi-public; it only for use by subclasses, all other code
392
 
        should consider it to be private.
393
 
        """
394
 
        self._revision_history_cache = rev_history
395
 
 
396
 
    def _cache_revision_id_to_revno(self, revision_id_to_revno):
397
 
        """Set the cached revision_id => revno map to revision_id_to_revno.
398
 
 
399
 
        This API is semi-public; it only for use by subclasses, all other code
400
 
        should consider it to be private.
401
 
        """
402
 
        self._revision_id_to_revno_cache = revision_id_to_revno
403
 
 
404
 
    def _clear_cached_state(self):
405
 
        """Clear any cached data on this branch, e.g. cached revision history.
406
 
 
407
 
        This means the next call to revision_history will need to call
408
 
        _gen_revision_history.
409
 
 
410
 
        This API is semi-public; it only for use by subclasses, all other code
411
 
        should consider it to be private.
412
 
        """
413
 
        self._revision_history_cache = None
414
 
        self._revision_id_to_revno_cache = None
415
 
 
416
 
    def _gen_revision_history(self):
417
 
        """Return sequence of revision hashes on to this branch.
418
 
        
419
 
        Unlike revision_history, this method always regenerates or rereads the
420
 
        revision history, i.e. it does not cache the result, so repeated calls
421
 
        may be expensive.
422
 
 
423
 
        Concrete subclasses should override this instead of revision_history so
424
 
        that subclasses do not need to deal with caching logic.
425
 
        
426
 
        This API is semi-public; it only for use by subclasses, all other code
427
 
        should consider it to be private.
428
 
        """
429
 
        raise NotImplementedError(self._gen_revision_history)
430
 
 
431
 
    @needs_read_lock
 
455
        self.lock_read()
 
456
        try:
 
457
            tree = self.revision_tree(self.lookup_revision(revno))
 
458
            # use inventory as it was in that revision
 
459
            file_id = tree.inventory.path2id(file)
 
460
            if not file_id:
 
461
                raise BzrError("%r is not present in revision %d" % (file, revno))
 
462
            tree.print_file(file_id)
 
463
        finally:
 
464
            self.unlock()
 
465
 
 
466
 
 
467
    def remove(self, files, verbose=False):
 
468
        """Mark nominated files for removal from the inventory.
 
469
 
 
470
        This does not remove their text.  This does not run on 
 
471
 
 
472
        TODO: Refuse to remove modified files unless --force is given?
 
473
 
 
474
        TODO: Do something useful with directories.
 
475
 
 
476
        TODO: Should this remove the text or not?  Tough call; not
 
477
        removing may be useful and the user can just use use rm, and
 
478
        is the opposite of add.  Removing it is consistent with most
 
479
        other tools.  Maybe an option.
 
480
        """
 
481
        ## TODO: Normalize names
 
482
        ## TODO: Remove nested loops; better scalability
 
483
        if isinstance(files, types.StringTypes):
 
484
            files = [files]
 
485
 
 
486
        self.lock_write()
 
487
 
 
488
        try:
 
489
            tree = self.working_tree()
 
490
            inv = tree.inventory
 
491
 
 
492
            # do this before any modifications
 
493
            for f in files:
 
494
                fid = inv.path2id(f)
 
495
                if not fid:
 
496
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
497
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
498
                if verbose:
 
499
                    # having remove it, it must be either ignored or unknown
 
500
                    if tree.is_ignored(f):
 
501
                        new_status = 'I'
 
502
                    else:
 
503
                        new_status = '?'
 
504
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
505
                del inv[fid]
 
506
 
 
507
            self._write_inventory(inv)
 
508
        finally:
 
509
            self.unlock()
 
510
 
 
511
 
 
512
    # FIXME: this doesn't need to be a branch method
 
513
    def set_inventory(self, new_inventory_list):
 
514
        inv = Inventory()
 
515
        for path, file_id, parent, kind in new_inventory_list:
 
516
            name = os.path.basename(path)
 
517
            if name == "":
 
518
                continue
 
519
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
520
        self._write_inventory(inv)
 
521
 
 
522
 
 
523
    def unknowns(self):
 
524
        """Return all unknown files.
 
525
 
 
526
        These are files in the working directory that are not versioned or
 
527
        control files or ignored.
 
528
        
 
529
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
530
        >>> list(b.unknowns())
 
531
        ['foo']
 
532
        >>> b.add('foo')
 
533
        >>> list(b.unknowns())
 
534
        []
 
535
        >>> b.remove('foo')
 
536
        >>> list(b.unknowns())
 
537
        ['foo']
 
538
        """
 
539
        return self.working_tree().unknowns()
 
540
 
 
541
 
 
542
    def append_revision(self, revision_id):
 
543
        from bzrlib.atomicfile import AtomicFile
 
544
 
 
545
        mutter("add {%s} to revision-history" % revision_id)
 
546
        rev_history = self.revision_history() + [revision_id]
 
547
 
 
548
        f = AtomicFile(self.controlfilename('revision-history'))
 
549
        try:
 
550
            for rev_id in rev_history:
 
551
                print >>f, rev_id
 
552
            f.commit()
 
553
        finally:
 
554
            f.close()
 
555
 
 
556
 
 
557
    def get_revision(self, revision_id):
 
558
        """Return the Revision object for a named revision"""
 
559
        if not revision_id or not isinstance(revision_id, basestring):
 
560
            raise ValueError('invalid revision-id: %r' % revision_id)
 
561
        r = Revision.read_xml(self.revision_store[revision_id])
 
562
        assert r.revision_id == revision_id
 
563
        return r
 
564
 
 
565
    def get_revision_sha1(self, revision_id):
 
566
        """Hash the stored value of a revision, and return it."""
 
567
        # In the future, revision entries will be signed. At that
 
568
        # point, it is probably best *not* to include the signature
 
569
        # in the revision hash. Because that lets you re-sign
 
570
        # the revision, (add signatures/remove signatures) and still
 
571
        # have all hash pointers stay consistent.
 
572
        # But for now, just hash the contents.
 
573
        return sha_file(self.revision_store[revision_id])
 
574
 
 
575
 
 
576
    def get_inventory(self, inventory_id):
 
577
        """Get Inventory object by hash.
 
578
 
 
579
        TODO: Perhaps for this and similar methods, take a revision
 
580
               parameter which can be either an integer revno or a
 
581
               string hash."""
 
582
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
583
        return i
 
584
 
 
585
    def get_inventory_sha1(self, inventory_id):
 
586
        """Return the sha1 hash of the inventory entry
 
587
        """
 
588
        return sha_file(self.inventory_store[inventory_id])
 
589
 
 
590
 
 
591
    def get_revision_inventory(self, revision_id):
 
592
        """Return inventory of a past revision."""
 
593
        if revision_id == None:
 
594
            return Inventory()
 
595
        else:
 
596
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
597
 
 
598
 
432
599
    def revision_history(self):
433
600
        """Return sequence of revision hashes on to this branch.
434
 
        
435
 
        This method will cache the revision history for as long as it is safe to
436
 
        do so.
437
 
        """
438
 
        if self._revision_history_cache is not None:
439
 
            history = self._revision_history_cache
 
601
 
 
602
        >>> ScratchBranch().revision_history()
 
603
        []
 
604
        """
 
605
        self.lock_read()
 
606
        try:
 
607
            return [l.rstrip('\r\n') for l in
 
608
                    self.controlfile('revision-history', 'r').readlines()]
 
609
        finally:
 
610
            self.unlock()
 
611
 
 
612
 
 
613
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
614
        """
 
615
        >>> import commit
 
616
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
617
        >>> sb.common_ancestor(sb) == (None, None)
 
618
        True
 
619
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
620
        >>> sb.common_ancestor(sb)[0]
 
621
        1
 
622
        >>> clone = sb.clone()
 
623
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
624
        >>> sb.common_ancestor(sb)[0]
 
625
        2
 
626
        >>> sb.common_ancestor(clone)[0]
 
627
        1
 
628
        >>> commit.commit(clone, "Committing divergent second revision", 
 
629
        ...               verbose=False)
 
630
        >>> sb.common_ancestor(clone)[0]
 
631
        1
 
632
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
633
        True
 
634
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
635
        True
 
636
        >>> clone2 = sb.clone()
 
637
        >>> sb.common_ancestor(clone2)[0]
 
638
        2
 
639
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
640
        1
 
641
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
642
        1
 
643
        """
 
644
        my_history = self.revision_history()
 
645
        other_history = other.revision_history()
 
646
        if self_revno is None:
 
647
            self_revno = len(my_history)
 
648
        if other_revno is None:
 
649
            other_revno = len(other_history)
 
650
        indices = range(min((self_revno, other_revno)))
 
651
        indices.reverse()
 
652
        for r in indices:
 
653
            if my_history[r] == other_history[r]:
 
654
                return r+1, my_history[r]
 
655
        return None, None
 
656
 
 
657
    def enum_history(self, direction):
 
658
        """Return (revno, revision_id) for history of branch.
 
659
 
 
660
        direction
 
661
            'forward' is from earliest to latest
 
662
            'reverse' is from latest to earliest
 
663
        """
 
664
        rh = self.revision_history()
 
665
        if direction == 'forward':
 
666
            i = 1
 
667
            for rid in rh:
 
668
                yield i, rid
 
669
                i += 1
 
670
        elif direction == 'reverse':
 
671
            i = len(rh)
 
672
            while i > 0:
 
673
                yield i, rh[i-1]
 
674
                i -= 1
440
675
        else:
441
 
            history = self._gen_revision_history()
442
 
            self._cache_revision_history(history)
443
 
        return list(history)
 
676
            raise ValueError('invalid history direction', direction)
 
677
 
444
678
 
445
679
    def revno(self):
446
680
        """Return current revision number for this branch.
450
684
        """
451
685
        return len(self.revision_history())
452
686
 
453
 
    def unbind(self):
454
 
        """Older format branches cannot bind or unbind."""
455
 
        raise errors.UpgradeRequired(self.base)
456
 
 
457
 
    def set_append_revisions_only(self, enabled):
458
 
        """Older format branches are never restricted to append-only"""
459
 
        raise errors.UpgradeRequired(self.base)
460
 
 
461
 
    def last_revision(self):
462
 
        """Return last revision id, or None"""
 
687
 
 
688
    def last_patch(self):
 
689
        """Return last patch hash, or None if no history.
 
690
        """
463
691
        ph = self.revision_history()
464
692
        if ph:
465
693
            return ph[-1]
466
694
        else:
467
695
            return None
468
696
 
469
 
    def last_revision_info(self):
470
 
        """Return information about the last revision.
471
 
 
472
 
        :return: A tuple (revno, last_revision_id).
473
 
        """
474
 
        rh = self.revision_history()
475
 
        revno = len(rh)
476
 
        if revno:
477
 
            return (revno, rh[-1])
478
 
        else:
479
 
            return (0, _mod_revision.NULL_REVISION)
480
697
 
481
698
    def missing_revisions(self, other, stop_revision=None):
482
 
        """Return a list of new revisions that would perfectly fit.
483
 
        
 
699
        """
484
700
        If self and other have not diverged, return a list of the revisions
485
701
        present in other, but missing from self.
 
702
 
 
703
        >>> from bzrlib.commit import commit
 
704
        >>> bzrlib.trace.silent = True
 
705
        >>> br1 = ScratchBranch()
 
706
        >>> br2 = ScratchBranch()
 
707
        >>> br1.missing_revisions(br2)
 
708
        []
 
709
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
710
        >>> br1.missing_revisions(br2)
 
711
        [u'REVISION-ID-1']
 
712
        >>> br2.missing_revisions(br1)
 
713
        []
 
714
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
715
        >>> br1.missing_revisions(br2)
 
716
        []
 
717
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
718
        >>> br1.missing_revisions(br2)
 
719
        [u'REVISION-ID-2A']
 
720
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
721
        >>> br1.missing_revisions(br2)
 
722
        Traceback (most recent call last):
 
723
        DivergedBranches: These branches have diverged.
486
724
        """
487
725
        self_history = self.revision_history()
488
726
        self_len = len(self_history)
495
733
 
496
734
        if stop_revision is None:
497
735
            stop_revision = other_len
498
 
        else:
499
 
            assert isinstance(stop_revision, int)
500
 
            if stop_revision > other_len:
501
 
                raise errors.NoSuchRevision(self, stop_revision)
 
736
        elif stop_revision > other_len:
 
737
            raise NoSuchRevision(self, stop_revision)
 
738
        
502
739
        return other_history[self_len:stop_revision]
503
740
 
 
741
 
504
742
    def update_revisions(self, other, stop_revision=None):
505
 
        """Pull in new perfect-fit revisions.
506
 
 
507
 
        :param other: Another Branch to pull from
508
 
        :param stop_revision: Updated until the given revision
509
 
        :return: None
 
743
        """Pull in all new revisions from other branch.
 
744
        
 
745
        >>> from bzrlib.commit import commit
 
746
        >>> bzrlib.trace.silent = True
 
747
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
748
        >>> br1.add('foo')
 
749
        >>> br1.add('bar')
 
750
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
751
        >>> br2 = ScratchBranch()
 
752
        >>> br2.update_revisions(br1)
 
753
        Added 2 texts.
 
754
        Added 1 inventories.
 
755
        Added 1 revisions.
 
756
        >>> br2.revision_history()
 
757
        [u'REVISION-ID-1']
 
758
        >>> br2.update_revisions(br1)
 
759
        Added 0 texts.
 
760
        Added 0 inventories.
 
761
        Added 0 revisions.
 
762
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
763
        True
510
764
        """
511
 
        raise NotImplementedError(self.update_revisions)
512
 
 
513
 
    def revision_id_to_revno(self, revision_id):
514
 
        """Given a revision id, return its revno"""
515
 
        if _mod_revision.is_null(revision_id):
516
 
            return 0
517
 
        revision_id = osutils.safe_revision_id(revision_id)
518
 
        history = self.revision_history()
519
 
        try:
520
 
            return history.index(revision_id) + 1
521
 
        except ValueError:
522
 
            raise errors.NoSuchRevision(self, revision_id)
523
 
 
524
 
    def get_rev_id(self, revno, history=None):
525
 
        """Find the revision id of the specified revno."""
 
765
        from bzrlib.progress import ProgressBar
 
766
 
 
767
        pb = ProgressBar()
 
768
 
 
769
        pb.update('comparing histories')
 
770
        revision_ids = self.missing_revisions(other, stop_revision)
 
771
 
 
772
        if hasattr(other.revision_store, "prefetch"):
 
773
            other.revision_store.prefetch(revision_ids)
 
774
        if hasattr(other.inventory_store, "prefetch"):
 
775
            inventory_ids = [other.get_revision(r).inventory_id
 
776
                             for r in revision_ids]
 
777
            other.inventory_store.prefetch(inventory_ids)
 
778
                
 
779
        revisions = []
 
780
        needed_texts = sets.Set()
 
781
        i = 0
 
782
        for rev_id in revision_ids:
 
783
            i += 1
 
784
            pb.update('fetching revision', i, len(revision_ids))
 
785
            rev = other.get_revision(rev_id)
 
786
            revisions.append(rev)
 
787
            inv = other.get_inventory(str(rev.inventory_id))
 
788
            for key, entry in inv.iter_entries():
 
789
                if entry.text_id is None:
 
790
                    continue
 
791
                if entry.text_id not in self.text_store:
 
792
                    needed_texts.add(entry.text_id)
 
793
 
 
794
        pb.clear()
 
795
                    
 
796
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
797
        print "Added %d texts." % count 
 
798
        inventory_ids = [ f.inventory_id for f in revisions ]
 
799
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
800
                                                inventory_ids)
 
801
        print "Added %d inventories." % count 
 
802
        revision_ids = [ f.revision_id for f in revisions]
 
803
        count = self.revision_store.copy_multi(other.revision_store, 
 
804
                                               revision_ids)
 
805
        for revision_id in revision_ids:
 
806
            self.append_revision(revision_id)
 
807
        print "Added %d revisions." % count
 
808
                    
 
809
        
 
810
    def commit(self, *args, **kw):
 
811
        from bzrlib.commit import commit
 
812
        commit(self, *args, **kw)
 
813
        
 
814
 
 
815
    def lookup_revision(self, revno):
 
816
        """Return revision hash for revision number."""
526
817
        if revno == 0:
527
818
            return None
528
 
        if history is None:
529
 
            history = self.revision_history()
530
 
        if revno <= 0 or revno > len(history):
531
 
            raise errors.NoSuchRevision(self, revno)
532
 
        return history[revno - 1]
533
 
 
534
 
    def pull(self, source, overwrite=False, stop_revision=None):
535
 
        """Mirror source into this branch.
536
 
 
537
 
        This branch is considered to be 'local', having low latency.
538
 
 
539
 
        :returns: PullResult instance
540
 
        """
541
 
        raise NotImplementedError(self.pull)
542
 
 
543
 
    def push(self, target, overwrite=False, stop_revision=None):
544
 
        """Mirror this branch into target.
545
 
 
546
 
        This branch is considered to be 'local', having low latency.
547
 
        """
548
 
        raise NotImplementedError(self.push)
 
819
 
 
820
        try:
 
821
            # list is 0-based; revisions are 1-based
 
822
            return self.revision_history()[revno-1]
 
823
        except IndexError:
 
824
            raise BzrError("no such revision %s" % revno)
 
825
 
 
826
 
 
827
    def revision_tree(self, revision_id):
 
828
        """Return Tree for a revision on this branch.
 
829
 
 
830
        `revision_id` may be None for the null revision, in which case
 
831
        an `EmptyTree` is returned."""
 
832
        # TODO: refactor this to use an existing revision object
 
833
        # so we don't need to read it in twice.
 
834
        if revision_id == None:
 
835
            return EmptyTree()
 
836
        else:
 
837
            inv = self.get_revision_inventory(revision_id)
 
838
            return RevisionTree(self.text_store, inv)
 
839
 
 
840
 
 
841
    def working_tree(self):
 
842
        """Return a `Tree` for the working copy."""
 
843
        from workingtree import WorkingTree
 
844
        return WorkingTree(self.base, self.read_working_inventory())
 
845
 
549
846
 
550
847
    def basis_tree(self):
551
 
        """Return `Tree` object for last revision."""
552
 
        return self.repository.revision_tree(self.last_revision())
 
848
        """Return `Tree` object for last revision.
 
849
 
 
850
        If there are no revisions yet, return an `EmptyTree`.
 
851
        """
 
852
        r = self.last_patch()
 
853
        if r == None:
 
854
            return EmptyTree()
 
855
        else:
 
856
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
857
 
 
858
 
553
859
 
554
860
    def rename_one(self, from_rel, to_rel):
555
861
        """Rename one file.
556
862
 
557
863
        This can change the directory or the filename or both.
558
864
        """
559
 
        raise NotImplementedError(self.rename_one)
 
865
        self.lock_write()
 
866
        try:
 
867
            tree = self.working_tree()
 
868
            inv = tree.inventory
 
869
            if not tree.has_filename(from_rel):
 
870
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
871
            if tree.has_filename(to_rel):
 
872
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
873
 
 
874
            file_id = inv.path2id(from_rel)
 
875
            if file_id == None:
 
876
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
877
 
 
878
            if inv.path2id(to_rel):
 
879
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
880
 
 
881
            to_dir, to_tail = os.path.split(to_rel)
 
882
            to_dir_id = inv.path2id(to_dir)
 
883
            if to_dir_id == None and to_dir != '':
 
884
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
885
 
 
886
            mutter("rename_one:")
 
887
            mutter("  file_id    {%s}" % file_id)
 
888
            mutter("  from_rel   %r" % from_rel)
 
889
            mutter("  to_rel     %r" % to_rel)
 
890
            mutter("  to_dir     %r" % to_dir)
 
891
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
892
 
 
893
            inv.rename(file_id, to_dir_id, to_tail)
 
894
 
 
895
            print "%s => %s" % (from_rel, to_rel)
 
896
 
 
897
            from_abs = self.abspath(from_rel)
 
898
            to_abs = self.abspath(to_rel)
 
899
            try:
 
900
                os.rename(from_abs, to_abs)
 
901
            except OSError, e:
 
902
                raise BzrError("failed to rename %r to %r: %s"
 
903
                        % (from_abs, to_abs, e[1]),
 
904
                        ["rename rolled back"])
 
905
 
 
906
            self._write_inventory(inv)
 
907
        finally:
 
908
            self.unlock()
 
909
 
560
910
 
561
911
    def move(self, from_paths, to_name):
562
912
        """Rename files.
568
918
 
569
919
        Note that to_name is only the last component of the new name;
570
920
        this doesn't change the directory.
571
 
 
572
 
        This returns a list of (from_path, to_path) pairs for each
573
 
        entry that is moved.
574
 
        """
575
 
        raise NotImplementedError(self.move)
576
 
 
577
 
    def get_parent(self):
578
 
        """Return the parent location of the branch.
579
 
 
580
 
        This is the default location for push/pull/missing.  The usual
581
 
        pattern is that the user can override it by specifying a
582
 
        location.
583
 
        """
584
 
        raise NotImplementedError(self.get_parent)
585
 
 
586
 
    def _set_config_location(self, name, url, config=None,
587
 
                             make_relative=False):
588
 
        if config is None:
589
 
            config = self.get_config()
590
 
        if url is None:
591
 
            url = ''
592
 
        elif make_relative:
593
 
            url = urlutils.relative_url(self.base, url)
594
 
        config.set_user_option(name, url, warn_masked=True)
595
 
 
596
 
    def _get_config_location(self, name, config=None):
597
 
        if config is None:
598
 
            config = self.get_config()
599
 
        location = config.get_user_option(name)
600
 
        if location == '':
601
 
            location = None
602
 
        return location
603
 
 
604
 
    def get_submit_branch(self):
605
 
        """Return the submit location of the branch.
606
 
 
607
 
        This is the default location for bundle.  The usual
608
 
        pattern is that the user can override it by specifying a
609
 
        location.
610
 
        """
611
 
        return self.get_config().get_user_option('submit_branch')
612
 
 
613
 
    def set_submit_branch(self, location):
614
 
        """Return the submit location of the branch.
615
 
 
616
 
        This is the default location for bundle.  The usual
617
 
        pattern is that the user can override it by specifying a
618
 
        location.
619
 
        """
620
 
        self.get_config().set_user_option('submit_branch', location,
621
 
            warn_masked=True)
622
 
 
623
 
    def get_public_branch(self):
624
 
        """Return the public location of the branch.
625
 
 
626
 
        This is is used by merge directives.
627
 
        """
628
 
        return self._get_config_location('public_branch')
629
 
 
630
 
    def set_public_branch(self, location):
631
 
        """Return the submit location of the branch.
632
 
 
633
 
        This is the default location for bundle.  The usual
634
 
        pattern is that the user can override it by specifying a
635
 
        location.
636
 
        """
637
 
        self._set_config_location('public_branch', location)
638
 
 
639
 
    def get_push_location(self):
640
 
        """Return the None or the location to push this branch to."""
641
 
        push_loc = self.get_config().get_user_option('push_location')
642
 
        return push_loc
643
 
 
644
 
    def set_push_location(self, location):
645
 
        """Set a new push location for this branch."""
646
 
        raise NotImplementedError(self.set_push_location)
647
 
 
648
 
    def set_parent(self, url):
649
 
        raise NotImplementedError(self.set_parent)
650
 
 
651
 
    @needs_write_lock
652
 
    def update(self):
653
 
        """Synchronise this branch with the master branch if any. 
654
 
 
655
 
        :return: None or the last_revision pivoted out during the update.
656
 
        """
657
 
        return None
658
 
 
659
 
    def check_revno(self, revno):
660
 
        """\
661
 
        Check whether a revno corresponds to any revision.
662
 
        Zero (the NULL revision) is considered valid.
663
 
        """
664
 
        if revno != 0:
665
 
            self.check_real_revno(revno)
666
 
            
667
 
    def check_real_revno(self, revno):
668
 
        """\
669
 
        Check whether a revno corresponds to a real revision.
670
 
        Zero (the NULL revision) is considered invalid
671
 
        """
672
 
        if revno < 1 or revno > self.revno():
673
 
            raise InvalidRevisionNumber(revno)
674
 
 
675
 
    @needs_read_lock
676
 
    def clone(self, to_bzrdir, revision_id=None):
677
 
        """Clone this branch into to_bzrdir preserving all semantic values.
678
 
        
679
 
        revision_id: if not None, the revision history in the new branch will
680
 
                     be truncated to end with revision_id.
681
 
        """
682
 
        result = self._format.initialize(to_bzrdir)
683
 
        self.copy_content_into(result, revision_id=revision_id)
684
 
        return  result
685
 
 
686
 
    @needs_read_lock
687
 
    def sprout(self, to_bzrdir, revision_id=None):
688
 
        """Create a new line of development from the branch, into to_bzrdir.
689
 
        
690
 
        revision_id: if not None, the revision history in the new branch will
691
 
                     be truncated to end with revision_id.
692
 
        """
693
 
        result = self._format.initialize(to_bzrdir)
694
 
        self.copy_content_into(result, revision_id=revision_id)
695
 
        result.set_parent(self.bzrdir.root_transport.base)
696
 
        return result
697
 
 
698
 
    def _synchronize_history(self, destination, revision_id):
699
 
        """Synchronize last revision and revision history between branches.
700
 
 
701
 
        This version is most efficient when the destination is also a
702
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
703
 
        history is the true lefthand parent history, and all of the revisions
704
 
        are in the destination's repository.  If not, set_revision_history
705
 
        will fail.
706
 
 
707
 
        :param destination: The branch to copy the history into
708
 
        :param revision_id: The revision-id to truncate history at.  May
709
 
          be None to copy complete history.
710
 
        """
711
 
        if revision_id == _mod_revision.NULL_REVISION:
712
 
            new_history = []
713
 
        new_history = self.revision_history()
714
 
        if revision_id is not None and new_history != []:
715
 
            revision_id = osutils.safe_revision_id(revision_id)
716
 
            try:
717
 
                new_history = new_history[:new_history.index(revision_id) + 1]
718
 
            except ValueError:
719
 
                rev = self.repository.get_revision(revision_id)
720
 
                new_history = rev.get_history(self.repository)[1:]
721
 
        destination.set_revision_history(new_history)
722
 
 
723
 
    @needs_read_lock
724
 
    def copy_content_into(self, destination, revision_id=None):
725
 
        """Copy the content of self into destination.
726
 
 
727
 
        revision_id: if not None, the revision history in the new branch will
728
 
                     be truncated to end with revision_id.
729
 
        """
730
 
        self._synchronize_history(destination, revision_id)
731
 
        try:
732
 
            parent = self.get_parent()
733
 
        except errors.InaccessibleParent, e:
734
 
            mutter('parent was not accessible to copy: %s', e)
735
 
        else:
736
 
            if parent:
737
 
                destination.set_parent(parent)
738
 
        self.tags.merge_to(destination.tags)
739
 
 
740
 
    @needs_read_lock
741
 
    def check(self):
742
 
        """Check consistency of the branch.
743
 
 
744
 
        In particular this checks that revisions given in the revision-history
745
 
        do actually match up in the revision graph, and that they're all 
746
 
        present in the repository.
747
 
        
748
 
        Callers will typically also want to check the repository.
749
 
 
750
 
        :return: A BranchCheckResult.
751
 
        """
752
 
        mainline_parent_id = None
753
 
        for revision_id in self.revision_history():
754
 
            try:
755
 
                revision = self.repository.get_revision(revision_id)
756
 
            except errors.NoSuchRevision, e:
757
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
758
 
                            % revision_id)
759
 
            # In general the first entry on the revision history has no parents.
760
 
            # But it's not illegal for it to have parents listed; this can happen
761
 
            # in imports from Arch when the parents weren't reachable.
762
 
            if mainline_parent_id is not None:
763
 
                if mainline_parent_id not in revision.parent_ids:
764
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
765
 
                                        "parents of {%s}"
766
 
                                        % (mainline_parent_id, revision_id))
767
 
            mainline_parent_id = revision_id
768
 
        return BranchCheckResult(self)
769
 
 
770
 
    def _get_checkout_format(self):
771
 
        """Return the most suitable metadir for a checkout of this branch.
772
 
        Weaves are used if this branch's repository uses weaves.
773
 
        """
774
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
775
 
            from bzrlib.repofmt import weaverepo
776
 
            format = bzrdir.BzrDirMetaFormat1()
777
 
            format.repository_format = weaverepo.RepositoryFormat7()
778
 
        else:
779
 
            format = self.repository.bzrdir.checkout_metadir()
780
 
            format.set_branch_format(self._format)
781
 
        return format
782
 
 
783
 
    def create_checkout(self, to_location, revision_id=None,
784
 
                        lightweight=False):
785
 
        """Create a checkout of a branch.
786
 
        
787
 
        :param to_location: The url to produce the checkout at
788
 
        :param revision_id: The revision to check out
789
 
        :param lightweight: If True, produce a lightweight checkout, otherwise,
790
 
        produce a bound branch (heavyweight checkout)
791
 
        :return: The tree of the created checkout
792
 
        """
793
 
        t = transport.get_transport(to_location)
794
 
        t.ensure_base()
795
 
        if lightweight:
796
 
            format = self._get_checkout_format()
797
 
            checkout = format.initialize_on_transport(t)
798
 
            BranchReferenceFormat().initialize(checkout, self)
799
 
        else:
800
 
            format = self._get_checkout_format()
801
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
802
 
                to_location, force_new_tree=False, format=format)
803
 
            checkout = checkout_branch.bzrdir
804
 
            checkout_branch.bind(self)
805
 
            # pull up to the specified revision_id to set the initial 
806
 
            # branch tip correctly, and seed it with history.
807
 
            checkout_branch.pull(self, stop_revision=revision_id)
808
 
        tree = checkout.create_workingtree(revision_id)
809
 
        basis_tree = tree.basis_tree()
810
 
        basis_tree.lock_read()
811
 
        try:
812
 
            for path, file_id in basis_tree.iter_references():
813
 
                reference_parent = self.reference_parent(file_id, path)
814
 
                reference_parent.create_checkout(tree.abspath(path),
815
 
                    basis_tree.get_reference_revision(file_id, path),
816
 
                    lightweight)
817
 
        finally:
818
 
            basis_tree.unlock()
819
 
        return tree
820
 
 
821
 
    def reference_parent(self, file_id, path):
822
 
        """Return the parent branch for a tree-reference file_id
823
 
        :param file_id: The file_id of the tree reference
824
 
        :param path: The path of the file_id in the tree
825
 
        :return: A branch associated with the file_id
826
 
        """
827
 
        # FIXME should provide multiple branches, based on config
828
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
829
 
 
830
 
    def supports_tags(self):
831
 
        return self._format.supports_tags()
832
 
 
833
 
 
834
 
class BranchFormat(object):
835
 
    """An encapsulation of the initialization and open routines for a format.
836
 
 
837
 
    Formats provide three things:
838
 
     * An initialization routine,
839
 
     * a format string,
840
 
     * an open routine.
841
 
 
842
 
    Formats are placed in an dict by their format string for reference 
843
 
    during branch opening. Its not required that these be instances, they
844
 
    can be classes themselves with class methods - it simply depends on 
845
 
    whether state is needed for a given format or not.
846
 
 
847
 
    Once a format is deprecated, just deprecate the initialize and open
848
 
    methods on the format class. Do not deprecate the object, as the 
849
 
    object will be created every time regardless.
850
 
    """
851
 
 
852
 
    _default_format = None
853
 
    """The default format used for new branches."""
854
 
 
855
 
    _formats = {}
856
 
    """The known formats."""
857
 
 
858
 
    def __eq__(self, other):
859
 
        return self.__class__ is other.__class__
860
 
 
861
 
    def __ne__(self, other):
862
 
        return not (self == other)
863
 
 
864
 
    @classmethod
865
 
    def find_format(klass, a_bzrdir):
866
 
        """Return the format for the branch object in a_bzrdir."""
867
 
        try:
868
 
            transport = a_bzrdir.get_branch_transport(None)
869
 
            format_string = transport.get("format").read()
870
 
            return klass._formats[format_string]
871
 
        except NoSuchFile:
872
 
            raise NotBranchError(path=transport.base)
873
 
        except KeyError:
874
 
            raise errors.UnknownFormatError(format=format_string)
875
 
 
876
 
    @classmethod
877
 
    def get_default_format(klass):
878
 
        """Return the current default format."""
879
 
        return klass._default_format
880
 
 
881
 
    def get_reference(self, a_bzrdir):
882
 
        """Get the target reference of the branch in a_bzrdir.
883
 
 
884
 
        format probing must have been completed before calling
885
 
        this method - it is assumed that the format of the branch
886
 
        in a_bzrdir is correct.
887
 
 
888
 
        :param a_bzrdir: The bzrdir to get the branch data from.
889
 
        :return: None if the branch is not a reference branch.
890
 
        """
891
 
        return None
892
 
 
893
 
    def get_format_string(self):
894
 
        """Return the ASCII format string that identifies this format."""
895
 
        raise NotImplementedError(self.get_format_string)
896
 
 
897
 
    def get_format_description(self):
898
 
        """Return the short format description for this format."""
899
 
        raise NotImplementedError(self.get_format_description)
900
 
 
901
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
902
 
                           set_format=True):
903
 
        """Initialize a branch in a bzrdir, with specified files
904
 
 
905
 
        :param a_bzrdir: The bzrdir to initialize the branch in
906
 
        :param utf8_files: The files to create as a list of
907
 
            (filename, content) tuples
908
 
        :param set_format: If True, set the format with
909
 
            self.get_format_string.  (BzrBranch4 has its format set
910
 
            elsewhere)
911
 
        :return: a branch in this format
912
 
        """
913
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
914
 
        branch_transport = a_bzrdir.get_branch_transport(self)
915
 
        lock_map = {
916
 
            'metadir': ('lock', lockdir.LockDir),
917
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
918
 
        }
919
 
        lock_name, lock_class = lock_map[lock_type]
920
 
        control_files = lockable_files.LockableFiles(branch_transport,
921
 
            lock_name, lock_class)
922
 
        control_files.create_lock()
923
 
        control_files.lock_write()
924
 
        if set_format:
925
 
            control_files.put_utf8('format', self.get_format_string())
926
 
        try:
927
 
            for file, content in utf8_files:
928
 
                control_files.put_utf8(file, content)
929
 
        finally:
930
 
            control_files.unlock()
931
 
        return self.open(a_bzrdir, _found=True)
932
 
 
933
 
    def initialize(self, a_bzrdir):
934
 
        """Create a branch of this format in a_bzrdir."""
935
 
        raise NotImplementedError(self.initialize)
936
 
 
937
 
    def is_supported(self):
938
 
        """Is this format supported?
939
 
 
940
 
        Supported formats can be initialized and opened.
941
 
        Unsupported formats may not support initialization or committing or 
942
 
        some other features depending on the reason for not being supported.
943
 
        """
944
 
        return True
945
 
 
946
 
    def open(self, a_bzrdir, _found=False):
947
 
        """Return the branch object for a_bzrdir
948
 
 
949
 
        _found is a private parameter, do not use it. It is used to indicate
950
 
               if format probing has already be done.
951
 
        """
952
 
        raise NotImplementedError(self.open)
953
 
 
954
 
    @classmethod
955
 
    def register_format(klass, format):
956
 
        klass._formats[format.get_format_string()] = format
957
 
 
958
 
    @classmethod
959
 
    def set_default_format(klass, format):
960
 
        klass._default_format = format
961
 
 
962
 
    @classmethod
963
 
    def unregister_format(klass, format):
964
 
        assert klass._formats[format.get_format_string()] is format
965
 
        del klass._formats[format.get_format_string()]
966
 
 
967
 
    def __str__(self):
968
 
        return self.get_format_string().rstrip()
969
 
 
970
 
    def supports_tags(self):
971
 
        """True if this format supports tags stored in the branch"""
972
 
        return False  # by default
973
 
 
974
 
    # XXX: Probably doesn't really belong here -- mbp 20070212
975
 
    def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
976
 
            lock_class):
977
 
        branch_transport = a_bzrdir.get_branch_transport(self)
978
 
        control_files = lockable_files.LockableFiles(branch_transport,
979
 
            lock_filename, lock_class)
980
 
        control_files.create_lock()
981
 
        control_files.lock_write()
982
 
        try:
983
 
            for filename, content in utf8_files:
984
 
                control_files.put_utf8(filename, content)
985
 
        finally:
986
 
            control_files.unlock()
987
 
 
988
 
 
989
 
class BranchHooks(Hooks):
990
 
    """A dictionary mapping hook name to a list of callables for branch hooks.
991
 
    
992
 
    e.g. ['set_rh'] Is the list of items to be called when the
993
 
    set_revision_history function is invoked.
994
 
    """
995
 
 
996
 
    def __init__(self):
997
 
        """Create the default hooks.
998
 
 
999
 
        These are all empty initially, because by default nothing should get
1000
 
        notified.
1001
 
        """
1002
 
        Hooks.__init__(self)
1003
 
        # Introduced in 0.15:
1004
 
        # invoked whenever the revision history has been set
1005
 
        # with set_revision_history. The api signature is
1006
 
        # (branch, revision_history), and the branch will
1007
 
        # be write-locked.
1008
 
        self['set_rh'] = []
1009
 
        # invoked after a push operation completes.
1010
 
        # the api signature is
1011
 
        # (push_result)
1012
 
        # containing the members
1013
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1014
 
        # where local is the local target branch or None, master is the target 
1015
 
        # master branch, and the rest should be self explanatory. The source
1016
 
        # is read locked and the target branches write locked. Source will
1017
 
        # be the local low-latency branch.
1018
 
        self['post_push'] = []
1019
 
        # invoked after a pull operation completes.
1020
 
        # the api signature is
1021
 
        # (pull_result)
1022
 
        # containing the members
1023
 
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
1024
 
        # where local is the local branch or None, master is the target 
1025
 
        # master branch, and the rest should be self explanatory. The source
1026
 
        # is read locked and the target branches write locked. The local
1027
 
        # branch is the low-latency branch.
1028
 
        self['post_pull'] = []
1029
 
        # invoked after a commit operation completes.
1030
 
        # the api signature is 
1031
 
        # (local, master, old_revno, old_revid, new_revno, new_revid)
1032
 
        # old_revid is NULL_REVISION for the first commit to a branch.
1033
 
        self['post_commit'] = []
1034
 
        # invoked after a uncommit operation completes.
1035
 
        # the api signature is
1036
 
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
1037
 
        # local is the local branch or None, master is the target branch,
1038
 
        # and an empty branch recieves new_revno of 0, new_revid of None.
1039
 
        self['post_uncommit'] = []
1040
 
 
1041
 
 
1042
 
# install the default hooks into the Branch class.
1043
 
Branch.hooks = BranchHooks()
1044
 
 
1045
 
 
1046
 
class BzrBranchFormat4(BranchFormat):
1047
 
    """Bzr branch format 4.
1048
 
 
1049
 
    This format has:
1050
 
     - a revision-history file.
1051
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1052
 
    """
1053
 
 
1054
 
    def get_format_description(self):
1055
 
        """See BranchFormat.get_format_description()."""
1056
 
        return "Branch format 4"
1057
 
 
1058
 
    def initialize(self, a_bzrdir):
1059
 
        """Create a branch of this format in a_bzrdir."""
1060
 
        utf8_files = [('revision-history', ''),
1061
 
                      ('branch-name', ''),
1062
 
                      ]
1063
 
        return self._initialize_helper(a_bzrdir, utf8_files,
1064
 
                                       lock_type='branch4', set_format=False)
1065
 
 
1066
 
    def __init__(self):
1067
 
        super(BzrBranchFormat4, self).__init__()
1068
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1069
 
 
1070
 
    def open(self, a_bzrdir, _found=False):
1071
 
        """Return the branch object for a_bzrdir
1072
 
 
1073
 
        _found is a private parameter, do not use it. It is used to indicate
1074
 
               if format probing has already be done.
1075
 
        """
1076
 
        if not _found:
1077
 
            # we are being called directly and must probe.
1078
 
            raise NotImplementedError
1079
 
        return BzrBranch(_format=self,
1080
 
                         _control_files=a_bzrdir._control_files,
1081
 
                         a_bzrdir=a_bzrdir,
1082
 
                         _repository=a_bzrdir.open_repository())
1083
 
 
1084
 
    def __str__(self):
1085
 
        return "Bazaar-NG branch format 4"
1086
 
 
1087
 
 
1088
 
class BzrBranchFormat5(BranchFormat):
1089
 
    """Bzr branch format 5.
1090
 
 
1091
 
    This format has:
1092
 
     - a revision-history file.
1093
 
     - a format string
1094
 
     - a lock dir guarding the branch itself
1095
 
     - all of this stored in a branch/ subdirectory
1096
 
     - works with shared repositories.
1097
 
 
1098
 
    This format is new in bzr 0.8.
1099
 
    """
1100
 
 
1101
 
    def get_format_string(self):
1102
 
        """See BranchFormat.get_format_string()."""
1103
 
        return "Bazaar-NG branch format 5\n"
1104
 
 
1105
 
    def get_format_description(self):
1106
 
        """See BranchFormat.get_format_description()."""
1107
 
        return "Branch format 5"
1108
 
        
1109
 
    def initialize(self, a_bzrdir):
1110
 
        """Create a branch of this format in a_bzrdir."""
1111
 
        utf8_files = [('revision-history', ''),
1112
 
                      ('branch-name', ''),
1113
 
                      ]
1114
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1115
 
 
1116
 
    def __init__(self):
1117
 
        super(BzrBranchFormat5, self).__init__()
1118
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1119
 
 
1120
 
    def open(self, a_bzrdir, _found=False):
1121
 
        """Return the branch object for a_bzrdir
1122
 
 
1123
 
        _found is a private parameter, do not use it. It is used to indicate
1124
 
               if format probing has already be done.
1125
 
        """
1126
 
        if not _found:
1127
 
            format = BranchFormat.find_format(a_bzrdir)
1128
 
            assert format.__class__ == self.__class__
1129
 
        try:
1130
 
            transport = a_bzrdir.get_branch_transport(None)
1131
 
            control_files = lockable_files.LockableFiles(transport, 'lock',
1132
 
                                                         lockdir.LockDir)
1133
 
            return BzrBranch5(_format=self,
1134
 
                              _control_files=control_files,
1135
 
                              a_bzrdir=a_bzrdir,
1136
 
                              _repository=a_bzrdir.find_repository())
1137
 
        except NoSuchFile:
1138
 
            raise NotBranchError(path=transport.base)
1139
 
 
1140
 
 
1141
 
class BzrBranchFormat6(BzrBranchFormat5):
1142
 
    """Branch format with last-revision
1143
 
 
1144
 
    Unlike previous formats, this has no explicit revision history. Instead,
1145
 
    this just stores the last-revision, and the left-hand history leading
1146
 
    up to there is the history.
1147
 
 
1148
 
    This format was introduced in bzr 0.15
1149
 
    """
1150
 
 
1151
 
    def get_format_string(self):
1152
 
        """See BranchFormat.get_format_string()."""
1153
 
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
1154
 
 
1155
 
    def get_format_description(self):
1156
 
        """See BranchFormat.get_format_description()."""
1157
 
        return "Branch format 6"
1158
 
 
1159
 
    def initialize(self, a_bzrdir):
1160
 
        """Create a branch of this format in a_bzrdir."""
1161
 
        utf8_files = [('last-revision', '0 null:\n'),
1162
 
                      ('branch-name', ''),
1163
 
                      ('branch.conf', ''),
1164
 
                      ('tags', ''),
1165
 
                      ]
1166
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1167
 
 
1168
 
    def open(self, a_bzrdir, _found=False):
1169
 
        """Return the branch object for a_bzrdir
1170
 
 
1171
 
        _found is a private parameter, do not use it. It is used to indicate
1172
 
               if format probing has already be done.
1173
 
        """
1174
 
        if not _found:
1175
 
            format = BranchFormat.find_format(a_bzrdir)
1176
 
            assert format.__class__ == self.__class__
1177
 
        transport = a_bzrdir.get_branch_transport(None)
1178
 
        control_files = lockable_files.LockableFiles(transport, 'lock',
1179
 
                                                     lockdir.LockDir)
1180
 
        return BzrBranch6(_format=self,
1181
 
                          _control_files=control_files,
1182
 
                          a_bzrdir=a_bzrdir,
1183
 
                          _repository=a_bzrdir.find_repository())
1184
 
 
1185
 
    def supports_tags(self):
1186
 
        return True
1187
 
 
1188
 
 
1189
 
class BranchReferenceFormat(BranchFormat):
1190
 
    """Bzr branch reference format.
1191
 
 
1192
 
    Branch references are used in implementing checkouts, they
1193
 
    act as an alias to the real branch which is at some other url.
1194
 
 
1195
 
    This format has:
1196
 
     - A location file
1197
 
     - a format string
1198
 
    """
1199
 
 
1200
 
    def get_format_string(self):
1201
 
        """See BranchFormat.get_format_string()."""
1202
 
        return "Bazaar-NG Branch Reference Format 1\n"
1203
 
 
1204
 
    def get_format_description(self):
1205
 
        """See BranchFormat.get_format_description()."""
1206
 
        return "Checkout reference format 1"
1207
 
        
1208
 
    def get_reference(self, a_bzrdir):
1209
 
        """See BranchFormat.get_reference()."""
1210
 
        transport = a_bzrdir.get_branch_transport(None)
1211
 
        return transport.get('location').read()
1212
 
 
1213
 
    def initialize(self, a_bzrdir, target_branch=None):
1214
 
        """Create a branch of this format in a_bzrdir."""
1215
 
        if target_branch is None:
1216
 
            # this format does not implement branch itself, thus the implicit
1217
 
            # creation contract must see it as uninitializable
1218
 
            raise errors.UninitializableFormat(self)
1219
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1220
 
        branch_transport = a_bzrdir.get_branch_transport(self)
1221
 
        branch_transport.put_bytes('location',
1222
 
            target_branch.bzrdir.root_transport.base)
1223
 
        branch_transport.put_bytes('format', self.get_format_string())
1224
 
        return self.open(a_bzrdir, _found=True)
1225
 
 
1226
 
    def __init__(self):
1227
 
        super(BranchReferenceFormat, self).__init__()
1228
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1229
 
 
1230
 
    def _make_reference_clone_function(format, a_branch):
1231
 
        """Create a clone() routine for a branch dynamically."""
1232
 
        def clone(to_bzrdir, revision_id=None):
1233
 
            """See Branch.clone()."""
1234
 
            return format.initialize(to_bzrdir, a_branch)
1235
 
            # cannot obey revision_id limits when cloning a reference ...
1236
 
            # FIXME RBC 20060210 either nuke revision_id for clone, or
1237
 
            # emit some sort of warning/error to the caller ?!
1238
 
        return clone
1239
 
 
1240
 
    def open(self, a_bzrdir, _found=False, location=None):
1241
 
        """Return the branch that the branch reference in a_bzrdir points at.
1242
 
 
1243
 
        _found is a private parameter, do not use it. It is used to indicate
1244
 
               if format probing has already be done.
1245
 
        """
1246
 
        if not _found:
1247
 
            format = BranchFormat.find_format(a_bzrdir)
1248
 
            assert format.__class__ == self.__class__
1249
 
        if location is None:
1250
 
            location = self.get_reference(a_bzrdir)
1251
 
        real_bzrdir = bzrdir.BzrDir.open(location)
1252
 
        result = real_bzrdir.open_branch()
1253
 
        # this changes the behaviour of result.clone to create a new reference
1254
 
        # rather than a copy of the content of the branch.
1255
 
        # I did not use a proxy object because that needs much more extensive
1256
 
        # testing, and we are only changing one behaviour at the moment.
1257
 
        # If we decide to alter more behaviours - i.e. the implicit nickname
1258
 
        # then this should be refactored to introduce a tested proxy branch
1259
 
        # and a subclass of that for use in overriding clone() and ....
1260
 
        # - RBC 20060210
1261
 
        result.clone = self._make_reference_clone_function(result)
1262
 
        return result
1263
 
 
1264
 
 
1265
 
# formats which have no format string are not discoverable
1266
 
# and not independently creatable, so are not registered.
1267
 
__default_format = BzrBranchFormat5()
1268
 
BranchFormat.register_format(__default_format)
1269
 
BranchFormat.register_format(BranchReferenceFormat())
1270
 
BranchFormat.register_format(BzrBranchFormat6())
1271
 
BranchFormat.set_default_format(__default_format)
1272
 
_legacy_formats = [BzrBranchFormat4(),
1273
 
                   ]
1274
 
 
1275
 
class BzrBranch(Branch):
1276
 
    """A branch stored in the actual filesystem.
1277
 
 
1278
 
    Note that it's "local" in the context of the filesystem; it doesn't
1279
 
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
1280
 
    it's writable, and can be accessed via the normal filesystem API.
1281
 
    """
1282
 
    
1283
 
    def __init__(self, _format=None,
1284
 
                 _control_files=None, a_bzrdir=None, _repository=None):
1285
 
        """Create new branch object at a particular location."""
1286
 
        Branch.__init__(self)
1287
 
        if a_bzrdir is None:
1288
 
            raise ValueError('a_bzrdir must be supplied')
1289
 
        else:
1290
 
            self.bzrdir = a_bzrdir
1291
 
        # self._transport used to point to the directory containing the
1292
 
        # control directory, but was not used - now it's just the transport
1293
 
        # for the branch control files.  mbp 20070212
1294
 
        self._base = self.bzrdir.transport.clone('..').base
1295
 
        self._format = _format
1296
 
        if _control_files is None:
1297
 
            raise ValueError('BzrBranch _control_files is None')
1298
 
        self.control_files = _control_files
1299
 
        self._transport = _control_files._transport
1300
 
        self.repository = _repository
1301
 
 
1302
 
    def __str__(self):
1303
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
1304
 
 
1305
 
    __repr__ = __str__
1306
 
 
1307
 
    def _get_base(self):
1308
 
        """Returns the directory containing the control directory."""
1309
 
        return self._base
1310
 
 
1311
 
    base = property(_get_base, doc="The URL for the root of this branch.")
1312
 
 
1313
 
    def abspath(self, name):
1314
 
        """See Branch.abspath."""
1315
 
        return self.control_files._transport.abspath(name)
1316
 
 
1317
 
 
1318
 
    @deprecated_method(zero_sixteen)
1319
 
    @needs_read_lock
1320
 
    def get_root_id(self):
1321
 
        """See Branch.get_root_id."""
1322
 
        tree = self.repository.revision_tree(self.last_revision())
1323
 
        return tree.inventory.root.file_id
1324
 
 
1325
 
    def is_locked(self):
1326
 
        return self.control_files.is_locked()
1327
 
 
1328
 
    def lock_write(self, token=None):
1329
 
        repo_token = self.repository.lock_write()
1330
 
        try:
1331
 
            token = self.control_files.lock_write(token=token)
1332
 
        except:
1333
 
            self.repository.unlock()
1334
 
            raise
1335
 
        return token
1336
 
 
1337
 
    def lock_read(self):
1338
 
        self.repository.lock_read()
1339
 
        try:
1340
 
            self.control_files.lock_read()
1341
 
        except:
1342
 
            self.repository.unlock()
1343
 
            raise
1344
 
 
1345
 
    def unlock(self):
1346
 
        # TODO: test for failed two phase locks. This is known broken.
1347
 
        try:
1348
 
            self.control_files.unlock()
1349
 
        finally:
1350
 
            self.repository.unlock()
1351
 
        if not self.control_files.is_locked():
1352
 
            # we just released the lock
1353
 
            self._clear_cached_state()
1354
 
        
1355
 
    def peek_lock_mode(self):
1356
 
        if self.control_files._lock_count == 0:
1357
 
            return None
1358
 
        else:
1359
 
            return self.control_files._lock_mode
1360
 
 
1361
 
    def get_physical_lock_status(self):
1362
 
        return self.control_files.get_physical_lock_status()
1363
 
 
1364
 
    @needs_read_lock
1365
 
    def print_file(self, file, revision_id):
1366
 
        """See Branch.print_file."""
1367
 
        return self.repository.print_file(file, revision_id)
1368
 
 
1369
 
    @needs_write_lock
1370
 
    def append_revision(self, *revision_ids):
1371
 
        """See Branch.append_revision."""
1372
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1373
 
        for revision_id in revision_ids:
1374
 
            _mod_revision.check_not_reserved_id(revision_id)
1375
 
            mutter("add {%s} to revision-history" % revision_id)
1376
 
        rev_history = self.revision_history()
1377
 
        rev_history.extend(revision_ids)
1378
 
        self.set_revision_history(rev_history)
1379
 
 
1380
 
    def _write_revision_history(self, history):
1381
 
        """Factored out of set_revision_history.
1382
 
 
1383
 
        This performs the actual writing to disk.
1384
 
        It is intended to be called by BzrBranch5.set_revision_history."""
1385
 
        self.control_files.put_bytes(
1386
 
            'revision-history', '\n'.join(history))
1387
 
 
1388
 
    @needs_write_lock
1389
 
    def set_revision_history(self, rev_history):
1390
 
        """See Branch.set_revision_history."""
1391
 
        rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1392
 
        self._clear_cached_state()
1393
 
        self._write_revision_history(rev_history)
1394
 
        self._cache_revision_history(rev_history)
1395
 
        for hook in Branch.hooks['set_rh']:
1396
 
            hook(self, rev_history)
1397
 
 
1398
 
    @needs_write_lock
1399
 
    def set_last_revision_info(self, revno, revision_id):
1400
 
        revision_id = osutils.safe_revision_id(revision_id)
1401
 
        history = self._lefthand_history(revision_id)
1402
 
        assert len(history) == revno, '%d != %d' % (len(history), revno)
1403
 
        self.set_revision_history(history)
1404
 
 
1405
 
    def _gen_revision_history(self):
1406
 
        history = self.control_files.get('revision-history').read().split('\n')
1407
 
        if history[-1:] == ['']:
1408
 
            # There shouldn't be a trailing newline, but just in case.
1409
 
            history.pop()
1410
 
        return history
1411
 
 
1412
 
    def _lefthand_history(self, revision_id, last_rev=None,
1413
 
                          other_branch=None):
1414
 
        # stop_revision must be a descendant of last_revision
1415
 
        stop_graph = self.repository.get_revision_graph(revision_id)
1416
 
        if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1417
 
            and last_rev not in stop_graph):
1418
 
            # our previous tip is not merged into stop_revision
1419
 
            raise errors.DivergedBranches(self, other_branch)
1420
 
        # make a new revision history from the graph
1421
 
        current_rev_id = revision_id
1422
 
        new_history = []
1423
 
        while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1424
 
            new_history.append(current_rev_id)
1425
 
            current_rev_id_parents = stop_graph[current_rev_id]
1426
 
            try:
1427
 
                current_rev_id = current_rev_id_parents[0]
1428
 
            except IndexError:
1429
 
                current_rev_id = None
1430
 
        new_history.reverse()
1431
 
        return new_history
1432
 
 
1433
 
    @needs_write_lock
1434
 
    def generate_revision_history(self, revision_id, last_rev=None,
1435
 
        other_branch=None):
1436
 
        """Create a new revision history that will finish with revision_id.
1437
 
 
1438
 
        :param revision_id: the new tip to use.
1439
 
        :param last_rev: The previous last_revision. If not None, then this
1440
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
1441
 
        :param other_branch: The other branch that DivergedBranches should
1442
 
            raise with respect to.
1443
 
        """
1444
 
        revision_id = osutils.safe_revision_id(revision_id)
1445
 
        self.set_revision_history(self._lefthand_history(revision_id,
1446
 
            last_rev, other_branch))
1447
 
 
1448
 
    @needs_write_lock
1449
 
    def update_revisions(self, other, stop_revision=None):
1450
 
        """See Branch.update_revisions."""
1451
 
        other.lock_read()
1452
 
        try:
1453
 
            if stop_revision is None:
1454
 
                stop_revision = other.last_revision()
1455
 
                if stop_revision is None:
1456
 
                    # if there are no commits, we're done.
1457
 
                    return
1458
 
            else:
1459
 
                stop_revision = osutils.safe_revision_id(stop_revision)
1460
 
            # whats the current last revision, before we fetch [and change it
1461
 
            # possibly]
1462
 
            last_rev = _mod_revision.ensure_null(self.last_revision())
1463
 
            # we fetch here regardless of whether we need to so that we pickup
1464
 
            # filled in ghosts.
1465
 
            self.fetch(other, stop_revision)
1466
 
            if self.repository.get_graph().is_ancestor(stop_revision,
1467
 
                                                       last_rev):
1468
 
                return
1469
 
            self.generate_revision_history(stop_revision, last_rev=last_rev,
1470
 
                other_branch=other)
1471
 
        finally:
1472
 
            other.unlock()
1473
 
 
1474
 
    def basis_tree(self):
1475
 
        """See Branch.basis_tree."""
1476
 
        return self.repository.revision_tree(self.last_revision())
1477
 
 
1478
 
    @deprecated_method(zero_eight)
1479
 
    def working_tree(self):
1480
 
        """Create a Working tree object for this branch."""
1481
 
 
1482
 
        from bzrlib.transport.local import LocalTransport
1483
 
        if (self.base.find('://') != -1 or 
1484
 
            not isinstance(self._transport, LocalTransport)):
1485
 
            raise NoWorkingTree(self.base)
1486
 
        return self.bzrdir.open_workingtree()
1487
 
 
1488
 
    @needs_write_lock
1489
 
    def pull(self, source, overwrite=False, stop_revision=None,
1490
 
             _hook_master=None, run_hooks=True):
1491
 
        """See Branch.pull.
1492
 
 
1493
 
        :param _hook_master: Private parameter - set the branch to 
1494
 
            be supplied as the master to push hooks.
1495
 
        :param run_hooks: Private parameter - if false, this branch
1496
 
            is being called because it's the master of the primary branch,
1497
 
            so it should not run its hooks.
1498
 
        """
1499
 
        result = PullResult()
1500
 
        result.source_branch = source
1501
 
        result.target_branch = self
1502
 
        source.lock_read()
1503
 
        try:
1504
 
            result.old_revno, result.old_revid = self.last_revision_info()
1505
 
            try:
1506
 
                self.update_revisions(source, stop_revision)
1507
 
            except DivergedBranches:
1508
 
                if not overwrite:
1509
 
                    raise
1510
 
            if overwrite:
1511
 
                if stop_revision is None:
1512
 
                    stop_revision = source.last_revision()
1513
 
                self.generate_revision_history(stop_revision)
1514
 
            result.tag_conflicts = source.tags.merge_to(self.tags)
1515
 
            result.new_revno, result.new_revid = self.last_revision_info()
1516
 
            if _hook_master:
1517
 
                result.master_branch = _hook_master
1518
 
                result.local_branch = self
1519
 
            else:
1520
 
                result.master_branch = self
1521
 
                result.local_branch = None
1522
 
            if run_hooks:
1523
 
                for hook in Branch.hooks['post_pull']:
1524
 
                    hook(result)
1525
 
        finally:
1526
 
            source.unlock()
1527
 
        return result
1528
 
 
1529
 
    def _get_parent_location(self):
1530
 
        _locs = ['parent', 'pull', 'x-pull']
1531
 
        for l in _locs:
1532
 
            try:
1533
 
                return self.control_files.get(l).read().strip('\n')
1534
 
            except NoSuchFile:
1535
 
                pass
1536
 
        return None
1537
 
 
1538
 
    @needs_read_lock
1539
 
    def push(self, target, overwrite=False, stop_revision=None,
1540
 
             _override_hook_source_branch=None):
1541
 
        """See Branch.push.
1542
 
 
1543
 
        This is the basic concrete implementation of push()
1544
 
 
1545
 
        :param _override_hook_source_branch: If specified, run
1546
 
        the hooks passing this Branch as the source, rather than self.  
1547
 
        This is for use of RemoteBranch, where push is delegated to the
1548
 
        underlying vfs-based Branch. 
1549
 
        """
1550
 
        # TODO: Public option to disable running hooks - should be trivial but
1551
 
        # needs tests.
1552
 
        target.lock_write()
1553
 
        try:
1554
 
            result = self._push_with_bound_branches(target, overwrite,
1555
 
                    stop_revision,
1556
 
                    _override_hook_source_branch=_override_hook_source_branch)
1557
 
            return result
1558
 
        finally:
1559
 
            target.unlock()
1560
 
 
1561
 
    def _push_with_bound_branches(self, target, overwrite,
1562
 
            stop_revision,
1563
 
            _override_hook_source_branch=None):
1564
 
        """Push from self into target, and into target's master if any.
1565
 
        
1566
 
        This is on the base BzrBranch class even though it doesn't support 
1567
 
        bound branches because the *target* might be bound.
1568
 
        """
1569
 
        def _run_hooks():
1570
 
            if _override_hook_source_branch:
1571
 
                result.source_branch = _override_hook_source_branch
1572
 
            for hook in Branch.hooks['post_push']:
1573
 
                hook(result)
1574
 
 
1575
 
        bound_location = target.get_bound_location()
1576
 
        if bound_location and target.base != bound_location:
1577
 
            # there is a master branch.
1578
 
            #
1579
 
            # XXX: Why the second check?  Is it even supported for a branch to
1580
 
            # be bound to itself? -- mbp 20070507
1581
 
            master_branch = target.get_master_branch()
1582
 
            master_branch.lock_write()
1583
 
            try:
1584
 
                # push into the master from this branch.
1585
 
                self._basic_push(master_branch, overwrite, stop_revision)
1586
 
                # and push into the target branch from this. Note that we push from
1587
 
                # this branch again, because its considered the highest bandwidth
1588
 
                # repository.
1589
 
                result = self._basic_push(target, overwrite, stop_revision)
1590
 
                result.master_branch = master_branch
1591
 
                result.local_branch = target
1592
 
                _run_hooks()
1593
 
                return result
 
921
        """
 
922
        self.lock_write()
 
923
        try:
 
924
            ## TODO: Option to move IDs only
 
925
            assert not isinstance(from_paths, basestring)
 
926
            tree = self.working_tree()
 
927
            inv = tree.inventory
 
928
            to_abs = self.abspath(to_name)
 
929
            if not isdir(to_abs):
 
930
                raise BzrError("destination %r is not a directory" % to_abs)
 
931
            if not tree.has_filename(to_name):
 
932
                raise BzrError("destination %r not in working directory" % to_abs)
 
933
            to_dir_id = inv.path2id(to_name)
 
934
            if to_dir_id == None and to_name != '':
 
935
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
936
            to_dir_ie = inv[to_dir_id]
 
937
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
938
                raise BzrError("destination %r is not a directory" % to_abs)
 
939
 
 
940
            to_idpath = inv.get_idpath(to_dir_id)
 
941
 
 
942
            for f in from_paths:
 
943
                if not tree.has_filename(f):
 
944
                    raise BzrError("%r does not exist in working tree" % f)
 
945
                f_id = inv.path2id(f)
 
946
                if f_id == None:
 
947
                    raise BzrError("%r is not versioned" % f)
 
948
                name_tail = splitpath(f)[-1]
 
949
                dest_path = appendpath(to_name, name_tail)
 
950
                if tree.has_filename(dest_path):
 
951
                    raise BzrError("destination %r already exists" % dest_path)
 
952
                if f_id in to_idpath:
 
953
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
954
 
 
955
            # OK, so there's a race here, it's possible that someone will
 
956
            # create a file in this interval and then the rename might be
 
957
            # left half-done.  But we should have caught most problems.
 
958
 
 
959
            for f in from_paths:
 
960
                name_tail = splitpath(f)[-1]
 
961
                dest_path = appendpath(to_name, name_tail)
 
962
                print "%s => %s" % (f, dest_path)
 
963
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
964
                try:
 
965
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
966
                except OSError, e:
 
967
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
968
                            ["rename rolled back"])
 
969
 
 
970
            self._write_inventory(inv)
 
971
        finally:
 
972
            self.unlock()
 
973
 
 
974
 
 
975
    def revert(self, filenames, old_tree=None, backups=True):
 
976
        """Restore selected files to the versions from a previous tree.
 
977
 
 
978
        backups
 
979
            If true (default) backups are made of files before
 
980
            they're renamed.
 
981
        """
 
982
        from bzrlib.errors import NotVersionedError, BzrError
 
983
        from bzrlib.atomicfile import AtomicFile
 
984
        from bzrlib.osutils import backup_file
 
985
        
 
986
        inv = self.read_working_inventory()
 
987
        if old_tree is None:
 
988
            old_tree = self.basis_tree()
 
989
        old_inv = old_tree.inventory
 
990
 
 
991
        nids = []
 
992
        for fn in filenames:
 
993
            file_id = inv.path2id(fn)
 
994
            if not file_id:
 
995
                raise NotVersionedError("not a versioned file", fn)
 
996
            if not old_inv.has_id(file_id):
 
997
                raise BzrError("file not present in old tree", fn, file_id)
 
998
            nids.append((fn, file_id))
 
999
            
 
1000
        # TODO: Rename back if it was previously at a different location
 
1001
 
 
1002
        # TODO: If given a directory, restore the entire contents from
 
1003
        # the previous version.
 
1004
 
 
1005
        # TODO: Make a backup to a temporary file.
 
1006
 
 
1007
        # TODO: If the file previously didn't exist, delete it?
 
1008
        for fn, file_id in nids:
 
1009
            backup_file(fn)
 
1010
            
 
1011
            f = AtomicFile(fn, 'wb')
 
1012
            try:
 
1013
                f.write(old_tree.get_file(file_id).read())
 
1014
                f.commit()
1594
1015
            finally:
1595
 
                master_branch.unlock()
1596
 
        else:
1597
 
            # no master branch
1598
 
            result = self._basic_push(target, overwrite, stop_revision)
1599
 
            # TODO: Why set master_branch and local_branch if there's no
1600
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
1601
 
            # 20070504
1602
 
            result.master_branch = target
1603
 
            result.local_branch = None
1604
 
            _run_hooks()
1605
 
            return result
1606
 
 
1607
 
    def _basic_push(self, target, overwrite, stop_revision):
1608
 
        """Basic implementation of push without bound branches or hooks.
1609
 
 
1610
 
        Must be called with self read locked and target write locked.
1611
 
        """
1612
 
        result = PushResult()
1613
 
        result.source_branch = self
1614
 
        result.target_branch = target
1615
 
        result.old_revno, result.old_revid = target.last_revision_info()
1616
 
        try:
1617
 
            target.update_revisions(self, stop_revision)
1618
 
        except DivergedBranches:
1619
 
            if not overwrite:
1620
 
                raise
1621
 
        if overwrite:
1622
 
            target.set_revision_history(self.revision_history())
1623
 
        result.tag_conflicts = self.tags.merge_to(target.tags)
1624
 
        result.new_revno, result.new_revid = target.last_revision_info()
1625
 
        return result
1626
 
 
1627
 
    def get_parent(self):
1628
 
        """See Branch.get_parent."""
1629
 
 
1630
 
        assert self.base[-1] == '/'
1631
 
        parent = self._get_parent_location()
1632
 
        if parent is None:
1633
 
            return parent
1634
 
        # This is an old-format absolute path to a local branch
1635
 
        # turn it into a url
1636
 
        if parent.startswith('/'):
1637
 
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1638
 
        try:
1639
 
            return urlutils.join(self.base[:-1], parent)
1640
 
        except errors.InvalidURLJoin, e:
1641
 
            raise errors.InaccessibleParent(parent, self.base)
1642
 
 
1643
 
    def set_push_location(self, location):
1644
 
        """See Branch.set_push_location."""
1645
 
        self.get_config().set_user_option(
1646
 
            'push_location', location,
1647
 
            store=_mod_config.STORE_LOCATION_NORECURSE)
1648
 
 
1649
 
    @needs_write_lock
1650
 
    def set_parent(self, url):
1651
 
        """See Branch.set_parent."""
1652
 
        # TODO: Maybe delete old location files?
1653
 
        # URLs should never be unicode, even on the local fs,
1654
 
        # FIXUP this and get_parent in a future branch format bump:
1655
 
        # read and rewrite the file, and have the new format code read
1656
 
        # using .get not .get_utf8. RBC 20060125
1657
 
        if url is not None:
1658
 
            if isinstance(url, unicode):
1659
 
                try: 
1660
 
                    url = url.encode('ascii')
1661
 
                except UnicodeEncodeError:
1662
 
                    raise errors.InvalidURL(url,
1663
 
                        "Urls must be 7-bit ascii, "
1664
 
                        "use bzrlib.urlutils.escape")
1665
 
            url = urlutils.relative_url(self.base, url)
1666
 
        self._set_parent_location(url)
1667
 
 
1668
 
    def _set_parent_location(self, url):
1669
 
        if url is None:
1670
 
            self.control_files._transport.delete('parent')
1671
 
        else:
1672
 
            assert isinstance(url, str)
1673
 
            self.control_files.put_bytes('parent', url + '\n')
1674
 
 
1675
 
    @deprecated_function(zero_nine)
1676
 
    def tree_config(self):
1677
 
        """DEPRECATED; call get_config instead.  
1678
 
        TreeConfig has become part of BranchConfig."""
1679
 
        return TreeConfig(self)
1680
 
 
1681
 
 
1682
 
class BzrBranch5(BzrBranch):
1683
 
    """A format 5 branch. This supports new features over plan branches.
1684
 
 
1685
 
    It has support for a master_branch which is the data for bound branches.
 
1016
                f.close()
 
1017
 
 
1018
 
 
1019
 
 
1020
class ScratchBranch(Branch):
 
1021
    """Special test class: a branch that cleans up after itself.
 
1022
 
 
1023
    >>> b = ScratchBranch()
 
1024
    >>> isdir(b.base)
 
1025
    True
 
1026
    >>> bd = b.base
 
1027
    >>> b.destroy()
 
1028
    >>> isdir(bd)
 
1029
    False
1686
1030
    """
1687
 
 
1688
 
    def __init__(self,
1689
 
                 _format,
1690
 
                 _control_files,
1691
 
                 a_bzrdir,
1692
 
                 _repository):
1693
 
        super(BzrBranch5, self).__init__(_format=_format,
1694
 
                                         _control_files=_control_files,
1695
 
                                         a_bzrdir=a_bzrdir,
1696
 
                                         _repository=_repository)
1697
 
        
1698
 
    @needs_write_lock
1699
 
    def pull(self, source, overwrite=False, stop_revision=None,
1700
 
             run_hooks=True):
1701
 
        """Pull from source into self, updating my master if any.
1702
 
        
1703
 
        :param run_hooks: Private parameter - if false, this branch
1704
 
            is being called because it's the master of the primary branch,
1705
 
            so it should not run its hooks.
1706
 
        """
1707
 
        bound_location = self.get_bound_location()
1708
 
        master_branch = None
1709
 
        if bound_location and source.base != bound_location:
1710
 
            # not pulling from master, so we need to update master.
1711
 
            master_branch = self.get_master_branch()
1712
 
            master_branch.lock_write()
1713
 
        try:
1714
 
            if master_branch:
1715
 
                # pull from source into master.
1716
 
                master_branch.pull(source, overwrite, stop_revision,
1717
 
                    run_hooks=False)
1718
 
            return super(BzrBranch5, self).pull(source, overwrite,
1719
 
                stop_revision, _hook_master=master_branch,
1720
 
                run_hooks=run_hooks)
1721
 
        finally:
1722
 
            if master_branch:
1723
 
                master_branch.unlock()
1724
 
 
1725
 
    def get_bound_location(self):
1726
 
        try:
1727
 
            return self.control_files.get_utf8('bound').read()[:-1]
1728
 
        except errors.NoSuchFile:
1729
 
            return None
1730
 
 
1731
 
    @needs_read_lock
1732
 
    def get_master_branch(self):
1733
 
        """Return the branch we are bound to.
1734
 
        
1735
 
        :return: Either a Branch, or None
1736
 
 
1737
 
        This could memoise the branch, but if thats done
1738
 
        it must be revalidated on each new lock.
1739
 
        So for now we just don't memoise it.
1740
 
        # RBC 20060304 review this decision.
1741
 
        """
1742
 
        bound_loc = self.get_bound_location()
1743
 
        if not bound_loc:
1744
 
            return None
1745
 
        try:
1746
 
            return Branch.open(bound_loc)
1747
 
        except (errors.NotBranchError, errors.ConnectionError), e:
1748
 
            raise errors.BoundBranchConnectionFailure(
1749
 
                    self, bound_loc, e)
1750
 
 
1751
 
    @needs_write_lock
1752
 
    def set_bound_location(self, location):
1753
 
        """Set the target where this branch is bound to.
1754
 
 
1755
 
        :param location: URL to the target branch
1756
 
        """
1757
 
        if location:
1758
 
            self.control_files.put_utf8('bound', location+'\n')
1759
 
        else:
1760
 
            try:
1761
 
                self.control_files._transport.delete('bound')
1762
 
            except NoSuchFile:
1763
 
                return False
 
1031
    def __init__(self, files=[], dirs=[], base=None):
 
1032
        """Make a test branch.
 
1033
 
 
1034
        This creates a temporary directory and runs init-tree in it.
 
1035
 
 
1036
        If any files are listed, they are created in the working copy.
 
1037
        """
 
1038
        init = False
 
1039
        if base is None:
 
1040
            base = tempfile.mkdtemp()
 
1041
            init = True
 
1042
        Branch.__init__(self, base, init=init)
 
1043
        for d in dirs:
 
1044
            os.mkdir(self.abspath(d))
 
1045
            
 
1046
        for f in files:
 
1047
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1048
 
 
1049
 
 
1050
    def clone(self):
 
1051
        """
 
1052
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1053
        >>> clone = orig.clone()
 
1054
        >>> os.path.samefile(orig.base, clone.base)
 
1055
        False
 
1056
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1057
        True
 
1058
        """
 
1059
        base = tempfile.mkdtemp()
 
1060
        os.rmdir(base)
 
1061
        shutil.copytree(self.base, base, symlinks=True)
 
1062
        return ScratchBranch(base=base)
 
1063
        
 
1064
    def __del__(self):
 
1065
        self.destroy()
 
1066
 
 
1067
    def destroy(self):
 
1068
        """Destroy the test branch, removing the scratch directory."""
 
1069
        try:
 
1070
            if self.base:
 
1071
                mutter("delete ScratchBranch %s" % self.base)
 
1072
                shutil.rmtree(self.base)
 
1073
        except OSError, e:
 
1074
            # Work around for shutil.rmtree failing on Windows when
 
1075
            # readonly files are encountered
 
1076
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1077
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1078
                for name in files:
 
1079
                    os.chmod(os.path.join(root, name), 0700)
 
1080
            shutil.rmtree(self.base)
 
1081
        self.base = None
 
1082
 
 
1083
    
 
1084
 
 
1085
######################################################################
 
1086
# predicates
 
1087
 
 
1088
 
 
1089
def is_control_file(filename):
 
1090
    ## FIXME: better check
 
1091
    filename = os.path.normpath(filename)
 
1092
    while filename != '':
 
1093
        head, tail = os.path.split(filename)
 
1094
        ## mutter('check %r for control file' % ((head, tail), ))
 
1095
        if tail == bzrlib.BZRDIR:
1764
1096
            return True
1765
 
 
1766
 
    @needs_write_lock
1767
 
    def bind(self, other):
1768
 
        """Bind this branch to the branch other.
1769
 
 
1770
 
        This does not push or pull data between the branches, though it does
1771
 
        check for divergence to raise an error when the branches are not
1772
 
        either the same, or one a prefix of the other. That behaviour may not
1773
 
        be useful, so that check may be removed in future.
1774
 
        
1775
 
        :param other: The branch to bind to
1776
 
        :type other: Branch
1777
 
        """
1778
 
        # TODO: jam 20051230 Consider checking if the target is bound
1779
 
        #       It is debatable whether you should be able to bind to
1780
 
        #       a branch which is itself bound.
1781
 
        #       Committing is obviously forbidden,
1782
 
        #       but binding itself may not be.
1783
 
        #       Since we *have* to check at commit time, we don't
1784
 
        #       *need* to check here
1785
 
 
1786
 
        # we want to raise diverged if:
1787
 
        # last_rev is not in the other_last_rev history, AND
1788
 
        # other_last_rev is not in our history, and do it without pulling
1789
 
        # history around
1790
 
        last_rev = _mod_revision.ensure_null(self.last_revision())
1791
 
        if last_rev != _mod_revision.NULL_REVISION:
1792
 
            other.lock_read()
1793
 
            try:
1794
 
                other_last_rev = other.last_revision()
1795
 
                if not _mod_revision.is_null(other_last_rev):
1796
 
                    # neither branch is new, we have to do some work to
1797
 
                    # ascertain diversion.
1798
 
                    remote_graph = other.repository.get_revision_graph(
1799
 
                        other_last_rev)
1800
 
                    local_graph = self.repository.get_revision_graph(last_rev)
1801
 
                    if (last_rev not in remote_graph and
1802
 
                        other_last_rev not in local_graph):
1803
 
                        raise errors.DivergedBranches(self, other)
1804
 
            finally:
1805
 
                other.unlock()
1806
 
        self.set_bound_location(other.base)
1807
 
 
1808
 
    @needs_write_lock
1809
 
    def unbind(self):
1810
 
        """If bound, unbind"""
1811
 
        return self.set_bound_location(None)
1812
 
 
1813
 
    @needs_write_lock
1814
 
    def update(self):
1815
 
        """Synchronise this branch with the master branch if any. 
1816
 
 
1817
 
        :return: None or the last_revision that was pivoted out during the
1818
 
                 update.
1819
 
        """
1820
 
        master = self.get_master_branch()
1821
 
        if master is not None:
1822
 
            old_tip = _mod_revision.ensure_null(self.last_revision())
1823
 
            self.pull(master, overwrite=True)
1824
 
            if self.repository.get_graph().is_ancestor(old_tip,
1825
 
                _mod_revision.ensure_null(self.last_revision())):
1826
 
                return None
1827
 
            return old_tip
1828
 
        return None
1829
 
 
1830
 
 
1831
 
class BzrBranchExperimental(BzrBranch5):
1832
 
    """Bzr experimental branch format
1833
 
 
1834
 
    This format has:
1835
 
     - a revision-history file.
1836
 
     - a format string
1837
 
     - a lock dir guarding the branch itself
1838
 
     - all of this stored in a branch/ subdirectory
1839
 
     - works with shared repositories.
1840
 
     - a tag dictionary in the branch
1841
 
 
1842
 
    This format is new in bzr 0.15, but shouldn't be used for real data, 
1843
 
    only for testing.
1844
 
 
1845
 
    This class acts as it's own BranchFormat.
1846
 
    """
1847
 
 
1848
 
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1849
 
 
1850
 
    @classmethod
1851
 
    def get_format_string(cls):
1852
 
        """See BranchFormat.get_format_string()."""
1853
 
        return "Bazaar-NG branch format experimental\n"
1854
 
 
1855
 
    @classmethod
1856
 
    def get_format_description(cls):
1857
 
        """See BranchFormat.get_format_description()."""
1858
 
        return "Experimental branch format"
1859
 
 
1860
 
    @classmethod
1861
 
    def get_reference(cls, a_bzrdir):
1862
 
        """Get the target reference of the branch in a_bzrdir.
1863
 
 
1864
 
        format probing must have been completed before calling
1865
 
        this method - it is assumed that the format of the branch
1866
 
        in a_bzrdir is correct.
1867
 
 
1868
 
        :param a_bzrdir: The bzrdir to get the branch data from.
1869
 
        :return: None if the branch is not a reference branch.
1870
 
        """
1871
 
        return None
1872
 
 
1873
 
    @classmethod
1874
 
    def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1875
 
            lock_class):
1876
 
        branch_transport = a_bzrdir.get_branch_transport(cls)
1877
 
        control_files = lockable_files.LockableFiles(branch_transport,
1878
 
            lock_filename, lock_class)
1879
 
        control_files.create_lock()
1880
 
        control_files.lock_write()
1881
 
        try:
1882
 
            for filename, content in utf8_files:
1883
 
                control_files.put_utf8(filename, content)
1884
 
        finally:
1885
 
            control_files.unlock()
1886
 
        
1887
 
    @classmethod
1888
 
    def initialize(cls, a_bzrdir):
1889
 
        """Create a branch of this format in a_bzrdir."""
1890
 
        utf8_files = [('format', cls.get_format_string()),
1891
 
                      ('revision-history', ''),
1892
 
                      ('branch-name', ''),
1893
 
                      ('tags', ''),
1894
 
                      ]
1895
 
        cls._initialize_control_files(a_bzrdir, utf8_files,
1896
 
            'lock', lockdir.LockDir)
1897
 
        return cls.open(a_bzrdir, _found=True)
1898
 
 
1899
 
    @classmethod
1900
 
    def open(cls, a_bzrdir, _found=False):
1901
 
        """Return the branch object for a_bzrdir
1902
 
 
1903
 
        _found is a private parameter, do not use it. It is used to indicate
1904
 
               if format probing has already be done.
1905
 
        """
1906
 
        if not _found:
1907
 
            format = BranchFormat.find_format(a_bzrdir)
1908
 
            assert format.__class__ == cls
1909
 
        transport = a_bzrdir.get_branch_transport(None)
1910
 
        control_files = lockable_files.LockableFiles(transport, 'lock',
1911
 
                                                     lockdir.LockDir)
1912
 
        return cls(_format=cls,
1913
 
            _control_files=control_files,
1914
 
            a_bzrdir=a_bzrdir,
1915
 
            _repository=a_bzrdir.find_repository())
1916
 
 
1917
 
    @classmethod
1918
 
    def is_supported(cls):
1919
 
        return True
1920
 
 
1921
 
    def _make_tags(self):
1922
 
        return BasicTags(self)
1923
 
 
1924
 
    @classmethod
1925
 
    def supports_tags(cls):
1926
 
        return True
1927
 
 
1928
 
 
1929
 
BranchFormat.register_format(BzrBranchExperimental)
1930
 
 
1931
 
 
1932
 
class BzrBranch6(BzrBranch5):
1933
 
 
1934
 
    @needs_read_lock
1935
 
    def last_revision_info(self):
1936
 
        revision_string = self.control_files.get('last-revision').read()
1937
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1938
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
1939
 
        revno = int(revno)
1940
 
        return revno, revision_id
1941
 
 
1942
 
    def last_revision(self):
1943
 
        """Return last revision id, or None"""
1944
 
        revision_id = self.last_revision_info()[1]
1945
 
        if revision_id == _mod_revision.NULL_REVISION:
1946
 
            revision_id = None
1947
 
        return revision_id
1948
 
 
1949
 
    def _write_last_revision_info(self, revno, revision_id):
1950
 
        """Simply write out the revision id, with no checks.
1951
 
 
1952
 
        Use set_last_revision_info to perform this safely.
1953
 
 
1954
 
        Does not update the revision_history cache.
1955
 
        Intended to be called by set_last_revision_info and
1956
 
        _write_revision_history.
1957
 
        """
1958
 
        if revision_id is None:
1959
 
            revision_id = 'null:'
1960
 
        out_string = '%d %s\n' % (revno, revision_id)
1961
 
        self.control_files.put_bytes('last-revision', out_string)
1962
 
 
1963
 
    @needs_write_lock
1964
 
    def set_last_revision_info(self, revno, revision_id):
1965
 
        revision_id = osutils.safe_revision_id(revision_id)
1966
 
        if self._get_append_revisions_only():
1967
 
            self._check_history_violation(revision_id)
1968
 
        self._write_last_revision_info(revno, revision_id)
1969
 
        self._clear_cached_state()
1970
 
 
1971
 
    def _check_history_violation(self, revision_id):
1972
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
1973
 
        if _mod_revision.is_null(last_revision):
1974
 
            return
1975
 
        if last_revision not in self._lefthand_history(revision_id):
1976
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
1977
 
 
1978
 
    def _gen_revision_history(self):
1979
 
        """Generate the revision history from last revision
1980
 
        """
1981
 
        history = list(self.repository.iter_reverse_revision_history(
1982
 
            self.last_revision()))
1983
 
        history.reverse()
1984
 
        return history
1985
 
 
1986
 
    def _write_revision_history(self, history):
1987
 
        """Factored out of set_revision_history.
1988
 
 
1989
 
        This performs the actual writing to disk, with format-specific checks.
1990
 
        It is intended to be called by BzrBranch5.set_revision_history.
1991
 
        """
1992
 
        if len(history) == 0:
1993
 
            last_revision = 'null:'
1994
 
        else:
1995
 
            if history != self._lefthand_history(history[-1]):
1996
 
                raise errors.NotLefthandHistory(history)
1997
 
            last_revision = history[-1]
1998
 
        if self._get_append_revisions_only():
1999
 
            self._check_history_violation(last_revision)
2000
 
        self._write_last_revision_info(len(history), last_revision)
2001
 
 
2002
 
    @needs_write_lock
2003
 
    def append_revision(self, *revision_ids):
2004
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
2005
 
        if len(revision_ids) == 0:
2006
 
            return
2007
 
        prev_revno, prev_revision = self.last_revision_info()
2008
 
        for revision in self.repository.get_revisions(revision_ids):
2009
 
            if prev_revision == _mod_revision.NULL_REVISION:
2010
 
                if revision.parent_ids != []:
2011
 
                    raise errors.NotLeftParentDescendant(self, prev_revision,
2012
 
                                                         revision.revision_id)
2013
 
            else:
2014
 
                if revision.parent_ids[0] != prev_revision:
2015
 
                    raise errors.NotLeftParentDescendant(self, prev_revision,
2016
 
                                                         revision.revision_id)
2017
 
            prev_revision = revision.revision_id
2018
 
        self.set_last_revision_info(prev_revno + len(revision_ids),
2019
 
                                    revision_ids[-1])
2020
 
 
2021
 
    @needs_write_lock
2022
 
    def _set_parent_location(self, url):
2023
 
        """Set the parent branch"""
2024
 
        self._set_config_location('parent_location', url, make_relative=True)
2025
 
 
2026
 
    @needs_read_lock
2027
 
    def _get_parent_location(self):
2028
 
        """Set the parent branch"""
2029
 
        return self._get_config_location('parent_location')
2030
 
 
2031
 
    def set_push_location(self, location):
2032
 
        """See Branch.set_push_location."""
2033
 
        self._set_config_location('push_location', location)
2034
 
 
2035
 
    def set_bound_location(self, location):
2036
 
        """See Branch.set_push_location."""
2037
 
        result = None
2038
 
        config = self.get_config()
2039
 
        if location is None:
2040
 
            if config.get_user_option('bound') != 'True':
2041
 
                return False
2042
 
            else:
2043
 
                config.set_user_option('bound', 'False', warn_masked=True)
2044
 
                return True
2045
 
        else:
2046
 
            self._set_config_location('bound_location', location,
2047
 
                                      config=config)
2048
 
            config.set_user_option('bound', 'True', warn_masked=True)
2049
 
        return True
2050
 
 
2051
 
    def _get_bound_location(self, bound):
2052
 
        """Return the bound location in the config file.
2053
 
 
2054
 
        Return None if the bound parameter does not match"""
2055
 
        config = self.get_config()
2056
 
        config_bound = (config.get_user_option('bound') == 'True')
2057
 
        if config_bound != bound:
2058
 
            return None
2059
 
        return self._get_config_location('bound_location', config=config)
2060
 
 
2061
 
    def get_bound_location(self):
2062
 
        """See Branch.set_push_location."""
2063
 
        return self._get_bound_location(True)
2064
 
 
2065
 
    def get_old_bound_location(self):
2066
 
        """See Branch.get_old_bound_location"""
2067
 
        return self._get_bound_location(False)
2068
 
 
2069
 
    def set_append_revisions_only(self, enabled):
2070
 
        if enabled:
2071
 
            value = 'True'
2072
 
        else:
2073
 
            value = 'False'
2074
 
        self.get_config().set_user_option('append_revisions_only', value,
2075
 
            warn_masked=True)
2076
 
 
2077
 
    def _get_append_revisions_only(self):
2078
 
        value = self.get_config().get_user_option('append_revisions_only')
2079
 
        return value == 'True'
2080
 
 
2081
 
    def _synchronize_history(self, destination, revision_id):
2082
 
        """Synchronize last revision and revision history between branches.
2083
 
 
2084
 
        This version is most efficient when the destination is also a
2085
 
        BzrBranch6, but works for BzrBranch5, as long as the destination's
2086
 
        repository contains all the lefthand ancestors of the intended
2087
 
        last_revision.  If not, set_last_revision_info will fail.
2088
 
 
2089
 
        :param destination: The branch to copy the history into
2090
 
        :param revision_id: The revision-id to truncate history at.  May
2091
 
          be None to copy complete history.
2092
 
        """
2093
 
        if revision_id is None:
2094
 
            revno, revision_id = self.last_revision_info()
2095
 
        else:
2096
 
            # To figure out the revno for a random revision, we need to build
2097
 
            # the revision history, and count its length.
2098
 
            # We don't care about the order, just how long it is.
2099
 
            # Alternatively, we could start at the current location, and count
2100
 
            # backwards. But there is no guarantee that we will find it since
2101
 
            # it may be a merged revision.
2102
 
            revno = len(list(self.repository.iter_reverse_revision_history(
2103
 
                                                                revision_id)))
2104
 
        destination.set_last_revision_info(revno, revision_id)
2105
 
 
2106
 
    def _make_tags(self):
2107
 
        return BasicTags(self)
2108
 
 
2109
 
 
2110
 
######################################################################
2111
 
# results of operations
2112
 
 
2113
 
 
2114
 
class _Result(object):
2115
 
 
2116
 
    def _show_tag_conficts(self, to_file):
2117
 
        if not getattr(self, 'tag_conflicts', None):
2118
 
            return
2119
 
        to_file.write('Conflicting tags:\n')
2120
 
        for name, value1, value2 in self.tag_conflicts:
2121
 
            to_file.write('    %s\n' % (name, ))
2122
 
 
2123
 
 
2124
 
class PullResult(_Result):
2125
 
    """Result of a Branch.pull operation.
2126
 
 
2127
 
    :ivar old_revno: Revision number before pull.
2128
 
    :ivar new_revno: Revision number after pull.
2129
 
    :ivar old_revid: Tip revision id before pull.
2130
 
    :ivar new_revid: Tip revision id after pull.
2131
 
    :ivar source_branch: Source (local) branch object.
2132
 
    :ivar master_branch: Master branch of the target, or None.
2133
 
    :ivar target_branch: Target/destination branch object.
2134
 
    """
2135
 
 
2136
 
    def __int__(self):
2137
 
        # DEPRECATED: pull used to return the change in revno
2138
 
        return self.new_revno - self.old_revno
2139
 
 
2140
 
    def report(self, to_file):
2141
 
        if self.old_revid == self.new_revid:
2142
 
            to_file.write('No revisions to pull.\n')
2143
 
        else:
2144
 
            to_file.write('Now on revision %d.\n' % self.new_revno)
2145
 
        self._show_tag_conficts(to_file)
2146
 
 
2147
 
 
2148
 
class PushResult(_Result):
2149
 
    """Result of a Branch.push operation.
2150
 
 
2151
 
    :ivar old_revno: Revision number before push.
2152
 
    :ivar new_revno: Revision number after push.
2153
 
    :ivar old_revid: Tip revision id before push.
2154
 
    :ivar new_revid: Tip revision id after push.
2155
 
    :ivar source_branch: Source branch object.
2156
 
    :ivar master_branch: Master branch of the target, or None.
2157
 
    :ivar target_branch: Target/destination branch object.
2158
 
    """
2159
 
 
2160
 
    def __int__(self):
2161
 
        # DEPRECATED: push used to return the change in revno
2162
 
        return self.new_revno - self.old_revno
2163
 
 
2164
 
    def report(self, to_file):
2165
 
        """Write a human-readable description of the result."""
2166
 
        if self.old_revid == self.new_revid:
2167
 
            to_file.write('No new revisions to push.\n')
2168
 
        else:
2169
 
            to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2170
 
        self._show_tag_conficts(to_file)
2171
 
 
2172
 
 
2173
 
class BranchCheckResult(object):
2174
 
    """Results of checking branch consistency.
2175
 
 
2176
 
    :see: Branch.check
2177
 
    """
2178
 
 
2179
 
    def __init__(self, branch):
2180
 
        self.branch = branch
2181
 
 
2182
 
    def report_results(self, verbose):
2183
 
        """Report the check results via trace.note.
2184
 
        
2185
 
        :param verbose: Requests more detailed display of what was checked,
2186
 
            if any.
2187
 
        """
2188
 
        note('checked branch %s format %s',
2189
 
             self.branch.base,
2190
 
             self.branch._format)
2191
 
 
2192
 
 
2193
 
class Converter5to6(object):
2194
 
    """Perform an in-place upgrade of format 5 to format 6"""
2195
 
 
2196
 
    def convert(self, branch):
2197
 
        # Data for 5 and 6 can peacefully coexist.
2198
 
        format = BzrBranchFormat6()
2199
 
        new_branch = format.open(branch.bzrdir, _found=True)
2200
 
 
2201
 
        # Copy source data into target
2202
 
        new_branch.set_last_revision_info(*branch.last_revision_info())
2203
 
        new_branch.set_parent(branch.get_parent())
2204
 
        new_branch.set_bound_location(branch.get_bound_location())
2205
 
        new_branch.set_push_location(branch.get_push_location())
2206
 
 
2207
 
        # New branch has no tags by default
2208
 
        new_branch.tags._set_tag_dict({})
2209
 
 
2210
 
        # Copying done; now update target format
2211
 
        new_branch.control_files.put_utf8('format',
2212
 
            format.get_format_string())
2213
 
 
2214
 
        # Clean up old files
2215
 
        new_branch.control_files._transport.delete('revision-history')
2216
 
        try:
2217
 
            branch.set_parent(None)
2218
 
        except NoSuchFile:
2219
 
            pass
2220
 
        branch.set_bound_location(None)
 
1097
        if filename == head:
 
1098
            break
 
1099
        filename = head
 
1100
    return False
 
1101
 
 
1102
 
 
1103
 
 
1104
def gen_file_id(name):
 
1105
    """Return new file id.
 
1106
 
 
1107
    This should probably generate proper UUIDs, but for the moment we
 
1108
    cope with just randomness because running uuidgen every time is
 
1109
    slow."""
 
1110
    import re
 
1111
 
 
1112
    # get last component
 
1113
    idx = name.rfind('/')
 
1114
    if idx != -1:
 
1115
        name = name[idx+1 : ]
 
1116
    idx = name.rfind('\\')
 
1117
    if idx != -1:
 
1118
        name = name[idx+1 : ]
 
1119
 
 
1120
    # make it not a hidden file
 
1121
    name = name.lstrip('.')
 
1122
 
 
1123
    # remove any wierd characters; we don't escape them but rather
 
1124
    # just pull them out
 
1125
    name = re.sub(r'[^\w.]', '', name)
 
1126
 
 
1127
    s = hexlify(rand_bytes(8))
 
1128
    return '-'.join((name, compact_date(time.time()), s))