~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-06-06 10:25:20 UTC
  • mfrom: (1711.2.33 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060606102520-64c05752f159a669
[patch] Matthieu Moy, make 'bzr log --line' only use the first line as a summary.

Show diffs side-by-side

added added

removed removed

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