~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-09-29 12:49:59 UTC
  • mto: (1185.14.2)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: mbp@sourcefrog.net-20050929124959-df3f175844fc90ed
- remove redundant import

Show diffs side-by-side

added added

removed removed

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