~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-07-04 12:26:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050704122602-69901910521e62c3
- check command checks that all inventory-ids are the same as in the revision.

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
 
from sets import Set
19
 
 
20
 
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
 
import traceback, socket, fnmatch, difflib, time
22
 
from binascii import hexlify
 
18
import sys, os
23
19
 
24
20
import bzrlib
25
 
from inventory import Inventory
26
 
from trace import mutter, note
27
 
from tree import Tree, EmptyTree, RevisionTree
28
 
from inventory import InventoryEntry, Inventory
29
 
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
30
 
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
 
     joinpath, sha_string, file_kind, local_time_offset, appendpath
32
 
from store import ImmutableStore
33
 
from revision import Revision
34
 
from errors import bailout, BzrError
35
 
from textui import show_status
36
 
from diff import diff_trees
 
21
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
37
25
 
38
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
27
## TODO: Maybe include checks for common corruption of newlines, etc?
46
34
        return remotebranch.RemoteBranch(f, **args)
47
35
    else:
48
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)
49
82
        
50
83
 
51
84
def find_branch_root(f=None):
78
111
            raise BzrError('%r is not in a branch' % orig_f)
79
112
        f = head
80
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)
81
127
 
82
128
 
83
129
######################################################################
84
130
# branch objects
85
131
 
86
 
class Branch:
 
132
class Branch(object):
87
133
    """Branch holding a history of revisions.
88
134
 
89
135
    base
90
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.
91
147
    """
92
 
    _lockmode = None
 
148
    base = None
 
149
    _lock_mode = None
 
150
    _lock_count = None
 
151
    _lock = None
93
152
    
94
 
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
 
153
    def __init__(self, base, init=False, find_root=True):
95
154
        """Create new branch object at a particular location.
96
155
 
97
156
        base -- Base directory for the branch.
106
165
        In the test suite, creation of new trees is tested using the
107
166
        `ScratchBranch` class.
108
167
        """
 
168
        from bzrlib.store import ImmutableStore
109
169
        if init:
110
170
            self.base = os.path.realpath(base)
111
171
            self._make_control()
114
174
        else:
115
175
            self.base = os.path.realpath(base)
116
176
            if not isdir(self.controlfilename('.')):
117
 
                bailout("not a bzr branch: %s" % quotefn(base),
118
 
                        ['use "bzr init" to initialize a new working tree',
119
 
                         'current bzr can only operate from top-of-tree'])
 
177
                from errors import NotBranchError
 
178
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
179
                                     ['use "bzr init" to initialize a new working tree',
 
180
                                      'current bzr can only operate from top-of-tree'])
120
181
        self._check_format()
121
 
        self.lock(lock_mode)
122
182
 
123
183
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
124
184
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
132
192
    __repr__ = __str__
133
193
 
134
194
 
135
 
 
136
 
    def lock(self, mode='w'):
137
 
        """Lock the on-disk branch, excluding other processes."""
138
 
        try:
139
 
            import fcntl, errno
140
 
 
141
 
            if mode == 'w':
142
 
                lm = fcntl.LOCK_EX
143
 
                om = os.O_WRONLY | os.O_CREAT
144
 
            elif mode == 'r':
145
 
                lm = fcntl.LOCK_SH
146
 
                om = os.O_RDONLY
147
 
            else:
148
 
                raise BzrError("invalid locking mode %r" % mode)
149
 
 
150
 
            try:
151
 
                lockfile = os.open(self.controlfilename('branch-lock'), om)
152
 
            except OSError, e:
153
 
                if e.errno == errno.ENOENT:
154
 
                    # might not exist on branches from <0.0.4
155
 
                    self.controlfile('branch-lock', 'w').close()
156
 
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
157
 
                else:
158
 
                    raise e
 
195
    def __del__(self):
 
196
        if self._lock_mode or self._lock:
 
197
            from warnings import warn
 
198
            warn("branch %r was not explicitly unlocked" % self)
 
199
            self._lock.unlock()
 
200
 
 
201
 
 
202
 
 
203
    def lock_write(self):
 
204
        if self._lock_mode:
 
205
            if self._lock_mode != 'w':
 
206
                from errors import LockError
 
207
                raise LockError("can't upgrade to a write lock from %r" %
 
208
                                self._lock_mode)
 
209
            self._lock_count += 1
 
210
        else:
 
211
            from bzrlib.lock import WriteLock
 
212
 
 
213
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
214
            self._lock_mode = 'w'
 
215
            self._lock_count = 1
 
216
 
 
217
 
 
218
 
 
219
    def lock_read(self):
 
220
        if self._lock_mode:
 
221
            assert self._lock_mode in ('r', 'w'), \
 
222
                   "invalid lock mode %r" % self._lock_mode
 
223
            self._lock_count += 1
 
224
        else:
 
225
            from bzrlib.lock import ReadLock
 
226
 
 
227
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
228
            self._lock_mode = 'r'
 
229
            self._lock_count = 1
 
230
                        
 
231
 
159
232
            
160
 
            fcntl.lockf(lockfile, lm)
161
 
            def unlock():
162
 
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
163
 
                os.close(lockfile)
164
 
                self._lockmode = None
165
 
            self.unlock = unlock
166
 
            self._lockmode = mode
167
 
        except ImportError:
168
 
            warning("please write a locking method for platform %r" % sys.platform)
169
 
            def unlock():
170
 
                self._lockmode = None
171
 
            self.unlock = unlock
172
 
            self._lockmode = mode
173
 
 
174
 
 
175
 
    def _need_readlock(self):
176
 
        if self._lockmode not in ['r', 'w']:
177
 
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
178
 
 
179
 
    def _need_writelock(self):
180
 
        if self._lockmode not in ['w']:
181
 
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
 
233
    def unlock(self):
 
234
        if not self._lock_mode:
 
235
            from errors import LockError
 
236
            raise LockError('branch %r is not locked' % (self))
 
237
 
 
238
        if self._lock_count > 1:
 
239
            self._lock_count -= 1
 
240
        else:
 
241
            self._lock.unlock()
 
242
            self._lock = None
 
243
            self._lock_mode = self._lock_count = None
182
244
 
183
245
 
184
246
    def abspath(self, name):
190
252
        """Return path relative to this branch of something inside it.
191
253
 
192
254
        Raises an error if path is not in this branch."""
193
 
        rp = os.path.realpath(path)
194
 
        # FIXME: windows
195
 
        if not rp.startswith(self.base):
196
 
            bailout("path %r is not within branch %r" % (rp, self.base))
197
 
        rp = rp[len(self.base):]
198
 
        rp = rp.lstrip(os.sep)
199
 
        return rp
 
255
        return _relpath(self.base, path)
200
256
 
201
257
 
202
258
    def controlfilename(self, file_or_path):
203
259
        """Return location relative to branch."""
204
 
        if isinstance(file_or_path, types.StringTypes):
 
260
        if isinstance(file_or_path, basestring):
205
261
            file_or_path = [file_or_path]
206
262
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
207
263
 
234
290
 
235
291
 
236
292
    def _make_control(self):
 
293
        from bzrlib.inventory import Inventory
 
294
        from bzrlib.xml import pack_xml
 
295
        
237
296
        os.mkdir(self.controlfilename([]))
238
297
        self.controlfile('README', 'w').write(
239
298
            "This is a Bazaar-NG control directory.\n"
240
 
            "Do not change any files in this directory.")
 
299
            "Do not change any files in this directory.\n")
241
300
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
242
301
        for d in ('text-store', 'inventory-store', 'revision-store'):
243
302
            os.mkdir(self.controlfilename(d))
244
303
        for f in ('revision-history', 'merged-patches',
245
304
                  'pending-merged-patches', 'branch-name',
246
 
                  'branch-lock'):
 
305
                  'branch-lock',
 
306
                  'pending-merges'):
247
307
            self.controlfile(f, 'w').write('')
248
308
        mutter('created control directory in ' + self.base)
249
 
        Inventory().write_xml(self.controlfile('inventory','w'))
 
309
 
 
310
        pack_xml(Inventory(), self.controlfile('inventory','w'))
250
311
 
251
312
 
252
313
    def _check_format(self):
263
324
        fmt = self.controlfile('branch-format', 'r').read()
264
325
        fmt.replace('\r\n', '')
265
326
        if fmt != BZR_BRANCH_FORMAT:
266
 
            bailout('sorry, branch format %r not supported' % fmt,
267
 
                    ['use a different bzr version',
268
 
                     'or remove the .bzr directory and "bzr init" again'])
 
327
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
328
                           ['use a different bzr version',
 
329
                            'or remove the .bzr directory and "bzr init" again'])
 
330
 
269
331
 
270
332
 
271
333
    def read_working_inventory(self):
272
334
        """Read the working inventory."""
273
 
        self._need_readlock()
274
 
        before = time.time()
275
 
        # ElementTree does its own conversion from UTF-8, so open in
276
 
        # binary.
277
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
278
 
        mutter("loaded inventory of %d items in %f"
279
 
               % (len(inv), time.time() - before))
280
 
        return inv
281
 
 
 
335
        from bzrlib.inventory import Inventory
 
336
        from bzrlib.xml import unpack_xml
 
337
        from time import time
 
338
        before = time()
 
339
        self.lock_read()
 
340
        try:
 
341
            # ElementTree does its own conversion from UTF-8, so open in
 
342
            # binary.
 
343
            inv = unpack_xml(Inventory,
 
344
                                  self.controlfile('inventory', 'rb'))
 
345
            mutter("loaded inventory of %d items in %f"
 
346
                   % (len(inv), time() - before))
 
347
            return inv
 
348
        finally:
 
349
            self.unlock()
 
350
            
282
351
 
283
352
    def _write_inventory(self, inv):
284
353
        """Update the working inventory.
286
355
        That is to say, the inventory describing changes underway, that
287
356
        will be committed to the next revision.
288
357
        """
289
 
        self._need_writelock()
290
 
        ## TODO: factor out to atomicfile?  is rename safe on windows?
291
 
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
292
 
        tmpfname = self.controlfilename('inventory.tmp')
293
 
        tmpf = file(tmpfname, 'wb')
294
 
        inv.write_xml(tmpf)
295
 
        tmpf.close()
296
 
        inv_fname = self.controlfilename('inventory')
297
 
        if sys.platform == 'win32':
298
 
            os.remove(inv_fname)
299
 
        os.rename(tmpfname, inv_fname)
 
358
        from bzrlib.atomicfile import AtomicFile
 
359
        from bzrlib.xml import pack_xml
 
360
        
 
361
        self.lock_write()
 
362
        try:
 
363
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
364
            try:
 
365
                pack_xml(inv, f)
 
366
                f.commit()
 
367
            finally:
 
368
                f.close()
 
369
        finally:
 
370
            self.unlock()
 
371
        
300
372
        mutter('wrote working inventory')
301
 
 
 
373
            
302
374
 
303
375
    inventory = property(read_working_inventory, _write_inventory, None,
304
376
                         """Inventory for the working copy.""")
305
377
 
306
378
 
307
 
    def add(self, files, verbose=False):
 
379
    def add(self, files, verbose=False, ids=None):
308
380
        """Make files versioned.
309
381
 
310
382
        Note that the command line normally calls smart_add instead.
312
384
        This puts the files in the Added state, so that they will be
313
385
        recorded by the next commit.
314
386
 
 
387
        files
 
388
            List of paths to add, relative to the base of the tree.
 
389
 
 
390
        ids
 
391
            If set, use these instead of automatically generated ids.
 
392
            Must be the same length as the list of files, but may
 
393
            contain None for ids that are to be autogenerated.
 
394
 
315
395
        TODO: Perhaps have an option to add the ids even if the files do
316
 
               not (yet) exist.
 
396
              not (yet) exist.
317
397
 
318
398
        TODO: Perhaps return the ids of the files?  But then again it
319
 
               is easy to retrieve them if they're needed.
320
 
 
321
 
        TODO: Option to specify file id.
 
399
              is easy to retrieve them if they're needed.
322
400
 
323
401
        TODO: Adding a directory should optionally recurse down and
324
 
               add all non-ignored children.  Perhaps do that in a
325
 
               higher-level method.
326
 
 
327
 
        >>> b = ScratchBranch(files=['foo'])
328
 
        >>> 'foo' in b.unknowns()
329
 
        True
330
 
        >>> b.show_status()
331
 
        ?       foo
332
 
        >>> b.add('foo')
333
 
        >>> 'foo' in b.unknowns()
334
 
        False
335
 
        >>> bool(b.inventory.path2id('foo'))
336
 
        True
337
 
        >>> b.show_status()
338
 
        A       foo
339
 
 
340
 
        >>> b.add('foo')
341
 
        Traceback (most recent call last):
342
 
        ...
343
 
        BzrError: ('foo is already versioned', [])
344
 
 
345
 
        >>> b.add(['nothere'])
346
 
        Traceback (most recent call last):
347
 
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
 
402
              add all non-ignored children.  Perhaps do that in a
 
403
              higher-level method.
348
404
        """
349
 
        self._need_writelock()
350
 
 
 
405
        from bzrlib.textui import show_status
351
406
        # TODO: Re-adding a file that is removed in the working copy
352
407
        # should probably put it back with the previous ID.
353
 
        if isinstance(files, types.StringTypes):
 
408
        if isinstance(files, basestring):
 
409
            assert(ids is None or isinstance(ids, basestring))
354
410
            files = [files]
355
 
        
356
 
        inv = self.read_working_inventory()
357
 
        for f in files:
358
 
            if is_control_file(f):
359
 
                bailout("cannot add control file %s" % quotefn(f))
360
 
 
361
 
            fp = splitpath(f)
362
 
 
363
 
            if len(fp) == 0:
364
 
                bailout("cannot add top-level %r" % f)
365
 
                
366
 
            fullpath = os.path.normpath(self.abspath(f))
367
 
 
368
 
            try:
369
 
                kind = file_kind(fullpath)
370
 
            except OSError:
371
 
                # maybe something better?
372
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
373
 
            
374
 
            if kind != 'file' and kind != 'directory':
375
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
376
 
 
377
 
            file_id = gen_file_id(f)
378
 
            inv.add_path(f, kind=kind, file_id=file_id)
379
 
 
380
 
            if verbose:
381
 
                show_status('A', kind, quotefn(f))
382
 
                
383
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
384
 
            
385
 
        self._write_inventory(inv)
386
 
 
 
411
            if ids is not None:
 
412
                ids = [ids]
 
413
 
 
414
        if ids is None:
 
415
            ids = [None] * len(files)
 
416
        else:
 
417
            assert(len(ids) == len(files))
 
418
 
 
419
        self.lock_write()
 
420
        try:
 
421
            inv = self.read_working_inventory()
 
422
            for f,file_id in zip(files, ids):
 
423
                if is_control_file(f):
 
424
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
425
 
 
426
                fp = splitpath(f)
 
427
 
 
428
                if len(fp) == 0:
 
429
                    raise BzrError("cannot add top-level %r" % f)
 
430
 
 
431
                fullpath = os.path.normpath(self.abspath(f))
 
432
 
 
433
                try:
 
434
                    kind = file_kind(fullpath)
 
435
                except OSError:
 
436
                    # maybe something better?
 
437
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
438
 
 
439
                if kind != 'file' and kind != 'directory':
 
440
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
441
 
 
442
                if file_id is None:
 
443
                    file_id = gen_file_id(f)
 
444
                inv.add_path(f, kind=kind, file_id=file_id)
 
445
 
 
446
                if verbose:
 
447
                    print 'added', quotefn(f)
 
448
 
 
449
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
450
 
 
451
            self._write_inventory(inv)
 
452
        finally:
 
453
            self.unlock()
 
454
            
387
455
 
388
456
    def print_file(self, file, revno):
389
457
        """Print `file` to stdout."""
390
 
        self._need_readlock()
391
 
        tree = self.revision_tree(self.lookup_revision(revno))
392
 
        # use inventory as it was in that revision
393
 
        file_id = tree.inventory.path2id(file)
394
 
        if not file_id:
395
 
            bailout("%r is not present in revision %d" % (file, revno))
396
 
        tree.print_file(file_id)
397
 
        
 
458
        self.lock_read()
 
459
        try:
 
460
            tree = self.revision_tree(self.lookup_revision(revno))
 
461
            # use inventory as it was in that revision
 
462
            file_id = tree.inventory.path2id(file)
 
463
            if not file_id:
 
464
                raise BzrError("%r is not present in revision %d" % (file, revno))
 
465
            tree.print_file(file_id)
 
466
        finally:
 
467
            self.unlock()
 
468
 
398
469
 
399
470
    def remove(self, files, verbose=False):
400
471
        """Mark nominated files for removal from the inventory.
403
474
 
404
475
        TODO: Refuse to remove modified files unless --force is given?
405
476
 
406
 
        >>> b = ScratchBranch(files=['foo'])
407
 
        >>> b.add('foo')
408
 
        >>> b.inventory.has_filename('foo')
409
 
        True
410
 
        >>> b.remove('foo')
411
 
        >>> b.working_tree().has_filename('foo')
412
 
        True
413
 
        >>> b.inventory.has_filename('foo')
414
 
        False
415
 
        
416
 
        >>> b = ScratchBranch(files=['foo'])
417
 
        >>> b.add('foo')
418
 
        >>> b.commit('one')
419
 
        >>> b.remove('foo')
420
 
        >>> b.commit('two')
421
 
        >>> b.inventory.has_filename('foo') 
422
 
        False
423
 
        >>> b.basis_tree().has_filename('foo') 
424
 
        False
425
 
        >>> b.working_tree().has_filename('foo') 
426
 
        True
427
 
 
428
477
        TODO: Do something useful with directories.
429
478
 
430
479
        TODO: Should this remove the text or not?  Tough call; not
432
481
        is the opposite of add.  Removing it is consistent with most
433
482
        other tools.  Maybe an option.
434
483
        """
 
484
        from bzrlib.textui import show_status
435
485
        ## TODO: Normalize names
436
486
        ## TODO: Remove nested loops; better scalability
437
 
        self._need_writelock()
438
 
 
439
 
        if isinstance(files, types.StringTypes):
 
487
        if isinstance(files, basestring):
440
488
            files = [files]
441
 
        
442
 
        tree = self.working_tree()
443
 
        inv = tree.inventory
444
 
 
445
 
        # do this before any modifications
446
 
        for f in files:
447
 
            fid = inv.path2id(f)
448
 
            if not fid:
449
 
                bailout("cannot remove unversioned file %s" % quotefn(f))
450
 
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
451
 
            if verbose:
452
 
                # having remove it, it must be either ignored or unknown
453
 
                if tree.is_ignored(f):
454
 
                    new_status = 'I'
455
 
                else:
456
 
                    new_status = '?'
457
 
                show_status(new_status, inv[fid].kind, quotefn(f))
458
 
            del inv[fid]
459
 
 
 
489
 
 
490
        self.lock_write()
 
491
 
 
492
        try:
 
493
            tree = self.working_tree()
 
494
            inv = tree.inventory
 
495
 
 
496
            # do this before any modifications
 
497
            for f in files:
 
498
                fid = inv.path2id(f)
 
499
                if not fid:
 
500
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
501
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
502
                if verbose:
 
503
                    # having remove it, it must be either ignored or unknown
 
504
                    if tree.is_ignored(f):
 
505
                        new_status = 'I'
 
506
                    else:
 
507
                        new_status = '?'
 
508
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
509
                del inv[fid]
 
510
 
 
511
            self._write_inventory(inv)
 
512
        finally:
 
513
            self.unlock()
 
514
 
 
515
 
 
516
    # FIXME: this doesn't need to be a branch method
 
517
    def set_inventory(self, new_inventory_list):
 
518
        from bzrlib.inventory import Inventory, InventoryEntry
 
519
        inv = Inventory()
 
520
        for path, file_id, parent, kind in new_inventory_list:
 
521
            name = os.path.basename(path)
 
522
            if name == "":
 
523
                continue
 
524
            inv.add(InventoryEntry(file_id, name, kind, parent))
460
525
        self._write_inventory(inv)
461
526
 
462
527
 
479
544
        return self.working_tree().unknowns()
480
545
 
481
546
 
482
 
    def commit(self, message, timestamp=None, timezone=None,
483
 
               committer=None,
484
 
               verbose=False):
485
 
        """Commit working copy as a new revision.
486
 
        
487
 
        The basic approach is to add all the file texts into the
488
 
        store, then the inventory, then make a new revision pointing
489
 
        to that inventory and store that.
490
 
        
491
 
        This is not quite safe if the working copy changes during the
492
 
        commit; for the moment that is simply not allowed.  A better
493
 
        approach is to make a temporary copy of the files before
494
 
        computing their hashes, and then add those hashes in turn to
495
 
        the inventory.  This should mean at least that there are no
496
 
        broken hash pointers.  There is no way we can get a snapshot
497
 
        of the whole directory at an instant.  This would also have to
498
 
        be robust against files disappearing, moving, etc.  So the
499
 
        whole thing is a bit hard.
500
 
 
501
 
        timestamp -- if not None, seconds-since-epoch for a
502
 
             postdated/predated commit.
503
 
        """
504
 
        self._need_writelock()
505
 
 
506
 
        ## TODO: Show branch names
507
 
 
508
 
        # TODO: Don't commit if there are no changes, unless forced?
509
 
 
510
 
        # First walk over the working inventory; and both update that
511
 
        # and also build a new revision inventory.  The revision
512
 
        # inventory needs to hold the text-id, sha1 and size of the
513
 
        # actual file versions committed in the revision.  (These are
514
 
        # not present in the working inventory.)  We also need to
515
 
        # detect missing/deleted files, and remove them from the
516
 
        # working inventory.
517
 
 
518
 
        work_inv = self.read_working_inventory()
519
 
        inv = Inventory()
520
 
        basis = self.basis_tree()
521
 
        basis_inv = basis.inventory
522
 
        missing_ids = []
523
 
        for path, entry in work_inv.iter_entries():
524
 
            ## TODO: Cope with files that have gone missing.
525
 
 
526
 
            ## TODO: Check that the file kind has not changed from the previous
527
 
            ## revision of this file (if any).
528
 
 
529
 
            entry = entry.copy()
530
 
 
531
 
            p = self.abspath(path)
532
 
            file_id = entry.file_id
533
 
            mutter('commit prep file %s, id %r ' % (p, file_id))
534
 
 
535
 
            if not os.path.exists(p):
536
 
                mutter("    file is missing, removing from inventory")
537
 
                if verbose:
538
 
                    show_status('D', entry.kind, quotefn(path))
539
 
                missing_ids.append(file_id)
540
 
                continue
541
 
 
542
 
            # TODO: Handle files that have been deleted
543
 
 
544
 
            # TODO: Maybe a special case for empty files?  Seems a
545
 
            # waste to store them many times.
546
 
 
547
 
            inv.add(entry)
548
 
 
549
 
            if basis_inv.has_id(file_id):
550
 
                old_kind = basis_inv[file_id].kind
551
 
                if old_kind != entry.kind:
552
 
                    bailout("entry %r changed kind from %r to %r"
553
 
                            % (file_id, old_kind, entry.kind))
554
 
 
555
 
            if entry.kind == 'directory':
556
 
                if not isdir(p):
557
 
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
558
 
            elif entry.kind == 'file':
559
 
                if not isfile(p):
560
 
                    bailout("%s is entered as file but is not a file" % quotefn(p))
561
 
 
562
 
                content = file(p, 'rb').read()
563
 
 
564
 
                entry.text_sha1 = sha_string(content)
565
 
                entry.text_size = len(content)
566
 
 
567
 
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
568
 
                if (old_ie
569
 
                    and (old_ie.text_size == entry.text_size)
570
 
                    and (old_ie.text_sha1 == entry.text_sha1)):
571
 
                    ## assert content == basis.get_file(file_id).read()
572
 
                    entry.text_id = basis_inv[file_id].text_id
573
 
                    mutter('    unchanged from previous text_id {%s}' %
574
 
                           entry.text_id)
575
 
                    
576
 
                else:
577
 
                    entry.text_id = gen_file_id(entry.name)
578
 
                    self.text_store.add(content, entry.text_id)
579
 
                    mutter('    stored with text_id {%s}' % entry.text_id)
580
 
                    if verbose:
581
 
                        if not old_ie:
582
 
                            state = 'A'
583
 
                        elif (old_ie.name == entry.name
584
 
                              and old_ie.parent_id == entry.parent_id):
585
 
                            state = 'M'
586
 
                        else:
587
 
                            state = 'R'
588
 
 
589
 
                        show_status(state, entry.kind, quotefn(path))
590
 
 
591
 
        for file_id in missing_ids:
592
 
            # have to do this later so we don't mess up the iterator.
593
 
            # since parents may be removed before their children we
594
 
            # have to test.
595
 
 
596
 
            # FIXME: There's probably a better way to do this; perhaps
597
 
            # the workingtree should know how to filter itself.
598
 
            if work_inv.has_id(file_id):
599
 
                del work_inv[file_id]
600
 
 
601
 
 
602
 
        inv_id = rev_id = _gen_revision_id(time.time())
603
 
        
604
 
        inv_tmp = tempfile.TemporaryFile()
605
 
        inv.write_xml(inv_tmp)
606
 
        inv_tmp.seek(0)
607
 
        self.inventory_store.add(inv_tmp, inv_id)
608
 
        mutter('new inventory_id is {%s}' % inv_id)
609
 
 
610
 
        self._write_inventory(work_inv)
611
 
 
612
 
        if timestamp == None:
613
 
            timestamp = time.time()
614
 
 
615
 
        if committer == None:
616
 
            committer = username()
617
 
 
618
 
        if timezone == None:
619
 
            timezone = local_time_offset()
620
 
 
621
 
        mutter("building commit log message")
622
 
        rev = Revision(timestamp=timestamp,
623
 
                       timezone=timezone,
624
 
                       committer=committer,
625
 
                       precursor = self.last_patch(),
626
 
                       message = message,
627
 
                       inventory_id=inv_id,
628
 
                       revision_id=rev_id)
629
 
 
630
 
        rev_tmp = tempfile.TemporaryFile()
631
 
        rev.write_xml(rev_tmp)
632
 
        rev_tmp.seek(0)
633
 
        self.revision_store.add(rev_tmp, rev_id)
634
 
        mutter("new revision_id is {%s}" % rev_id)
635
 
        
636
 
        ## XXX: Everything up to here can simply be orphaned if we abort
637
 
        ## the commit; it will leave junk files behind but that doesn't
638
 
        ## matter.
639
 
 
640
 
        ## TODO: Read back the just-generated changeset, and make sure it
641
 
        ## applies and recreates the right state.
642
 
 
643
 
        ## TODO: Also calculate and store the inventory SHA1
644
 
        mutter("committing patch r%d" % (self.revno() + 1))
645
 
 
646
 
 
647
 
        self.append_revision(rev_id)
648
 
        
649
 
        if verbose:
650
 
            note("commited r%d" % self.revno())
651
 
 
652
 
 
653
547
    def append_revision(self, revision_id):
 
548
        from bzrlib.atomicfile import AtomicFile
 
549
 
654
550
        mutter("add {%s} to revision-history" % revision_id)
655
 
        rev_history = self.revision_history()
656
 
 
657
 
        tmprhname = self.controlfilename('revision-history.tmp')
658
 
        rhname = self.controlfilename('revision-history')
659
 
        
660
 
        f = file(tmprhname, 'wt')
661
 
        rev_history.append(revision_id)
662
 
        f.write('\n'.join(rev_history))
663
 
        f.write('\n')
664
 
        f.close()
665
 
 
666
 
        if sys.platform == 'win32':
667
 
            os.remove(rhname)
668
 
        os.rename(tmprhname, rhname)
669
 
        
 
551
        rev_history = self.revision_history() + [revision_id]
 
552
 
 
553
        f = AtomicFile(self.controlfilename('revision-history'))
 
554
        try:
 
555
            for rev_id in rev_history:
 
556
                print >>f, rev_id
 
557
            f.commit()
 
558
        finally:
 
559
            f.close()
670
560
 
671
561
 
672
562
    def get_revision(self, revision_id):
673
563
        """Return the Revision object for a named revision"""
674
 
        self._need_readlock()
675
 
        r = Revision.read_xml(self.revision_store[revision_id])
 
564
        from bzrlib.revision import Revision
 
565
        from bzrlib.xml import unpack_xml
 
566
 
 
567
        self.lock_read()
 
568
        try:
 
569
            if not revision_id or not isinstance(revision_id, basestring):
 
570
                raise ValueError('invalid revision-id: %r' % revision_id)
 
571
            r = unpack_xml(Revision, self.revision_store[revision_id])
 
572
        finally:
 
573
            self.unlock()
 
574
            
676
575
        assert r.revision_id == revision_id
677
576
        return r
 
577
        
 
578
 
 
579
    def get_revision_sha1(self, revision_id):
 
580
        """Hash the stored value of a revision, and return it."""
 
581
        # In the future, revision entries will be signed. At that
 
582
        # point, it is probably best *not* to include the signature
 
583
        # in the revision hash. Because that lets you re-sign
 
584
        # the revision, (add signatures/remove signatures) and still
 
585
        # have all hash pointers stay consistent.
 
586
        # But for now, just hash the contents.
 
587
        return sha_file(self.revision_store[revision_id])
678
588
 
679
589
 
680
590
    def get_inventory(self, inventory_id):
683
593
        TODO: Perhaps for this and similar methods, take a revision
684
594
               parameter which can be either an integer revno or a
685
595
               string hash."""
686
 
        self._need_readlock()
687
 
        i = Inventory.read_xml(self.inventory_store[inventory_id])
688
 
        return i
 
596
        from bzrlib.inventory import Inventory
 
597
        from bzrlib.xml import unpack_xml
 
598
 
 
599
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
 
600
            
 
601
 
 
602
    def get_inventory_sha1(self, inventory_id):
 
603
        """Return the sha1 hash of the inventory entry
 
604
        """
 
605
        return sha_file(self.inventory_store[inventory_id])
689
606
 
690
607
 
691
608
    def get_revision_inventory(self, revision_id):
692
609
        """Return inventory of a past revision."""
693
 
        self._need_readlock()
694
610
        if revision_id == None:
 
611
            from bzrlib.inventory import Inventory
695
612
            return Inventory()
696
613
        else:
697
614
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
703
620
        >>> ScratchBranch().revision_history()
704
621
        []
705
622
        """
706
 
        self._need_readlock()
707
 
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
708
 
 
 
623
        self.lock_read()
 
624
        try:
 
625
            return [l.rstrip('\r\n') for l in
 
626
                    self.controlfile('revision-history', 'r').readlines()]
 
627
        finally:
 
628
            self.unlock()
 
629
 
 
630
 
 
631
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
632
        """
 
633
        >>> import commit
 
634
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
635
        >>> sb.common_ancestor(sb) == (None, None)
 
636
        True
 
637
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
638
        >>> sb.common_ancestor(sb)[0]
 
639
        1
 
640
        >>> clone = sb.clone()
 
641
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
642
        >>> sb.common_ancestor(sb)[0]
 
643
        2
 
644
        >>> sb.common_ancestor(clone)[0]
 
645
        1
 
646
        >>> commit.commit(clone, "Committing divergent second revision", 
 
647
        ...               verbose=False)
 
648
        >>> sb.common_ancestor(clone)[0]
 
649
        1
 
650
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
651
        True
 
652
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
653
        True
 
654
        >>> clone2 = sb.clone()
 
655
        >>> sb.common_ancestor(clone2)[0]
 
656
        2
 
657
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
658
        1
 
659
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
660
        1
 
661
        """
 
662
        my_history = self.revision_history()
 
663
        other_history = other.revision_history()
 
664
        if self_revno is None:
 
665
            self_revno = len(my_history)
 
666
        if other_revno is None:
 
667
            other_revno = len(other_history)
 
668
        indices = range(min((self_revno, other_revno)))
 
669
        indices.reverse()
 
670
        for r in indices:
 
671
            if my_history[r] == other_history[r]:
 
672
                return r+1, my_history[r]
 
673
        return None, None
709
674
 
710
675
    def enum_history(self, direction):
711
676
        """Return (revno, revision_id) for history of branch.
726
691
                yield i, rh[i-1]
727
692
                i -= 1
728
693
        else:
729
 
            raise BzrError('invalid history direction %r' % direction)
 
694
            raise ValueError('invalid history direction', direction)
730
695
 
731
696
 
732
697
    def revno(self):
734
699
 
735
700
        That is equivalent to the number of revisions committed to
736
701
        this branch.
737
 
 
738
 
        >>> b = ScratchBranch()
739
 
        >>> b.revno()
740
 
        0
741
 
        >>> b.commit('no foo')
742
 
        >>> b.revno()
743
 
        1
744
702
        """
745
703
        return len(self.revision_history())
746
704
 
747
705
 
748
706
    def last_patch(self):
749
707
        """Return last patch hash, or None if no history.
750
 
 
751
 
        >>> ScratchBranch().last_patch() == None
752
 
        True
753
708
        """
754
709
        ph = self.revision_history()
755
710
        if ph:
756
711
            return ph[-1]
757
712
        else:
758
713
            return None
 
714
 
 
715
 
 
716
    def missing_revisions(self, other, stop_revision=None):
 
717
        """
 
718
        If self and other have not diverged, return a list of the revisions
 
719
        present in other, but missing from self.
 
720
 
 
721
        >>> from bzrlib.commit import commit
 
722
        >>> bzrlib.trace.silent = True
 
723
        >>> br1 = ScratchBranch()
 
724
        >>> br2 = ScratchBranch()
 
725
        >>> br1.missing_revisions(br2)
 
726
        []
 
727
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
728
        >>> br1.missing_revisions(br2)
 
729
        [u'REVISION-ID-1']
 
730
        >>> br2.missing_revisions(br1)
 
731
        []
 
732
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
733
        >>> br1.missing_revisions(br2)
 
734
        []
 
735
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
736
        >>> br1.missing_revisions(br2)
 
737
        [u'REVISION-ID-2A']
 
738
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
739
        >>> br1.missing_revisions(br2)
 
740
        Traceback (most recent call last):
 
741
        DivergedBranches: These branches have diverged.
 
742
        """
 
743
        self_history = self.revision_history()
 
744
        self_len = len(self_history)
 
745
        other_history = other.revision_history()
 
746
        other_len = len(other_history)
 
747
        common_index = min(self_len, other_len) -1
 
748
        if common_index >= 0 and \
 
749
            self_history[common_index] != other_history[common_index]:
 
750
            raise DivergedBranches(self, other)
 
751
 
 
752
        if stop_revision is None:
 
753
            stop_revision = other_len
 
754
        elif stop_revision > other_len:
 
755
            raise NoSuchRevision(self, stop_revision)
 
756
        
 
757
        return other_history[self_len:stop_revision]
 
758
 
 
759
 
 
760
    def update_revisions(self, other, stop_revision=None):
 
761
        """Pull in all new revisions from other branch.
 
762
        
 
763
        >>> from bzrlib.commit import commit
 
764
        >>> bzrlib.trace.silent = True
 
765
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
766
        >>> br1.add('foo')
 
767
        >>> br1.add('bar')
 
768
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
769
        >>> br2 = ScratchBranch()
 
770
        >>> br2.update_revisions(br1)
 
771
        Added 2 texts.
 
772
        Added 1 inventories.
 
773
        Added 1 revisions.
 
774
        >>> br2.revision_history()
 
775
        [u'REVISION-ID-1']
 
776
        >>> br2.update_revisions(br1)
 
777
        Added 0 texts.
 
778
        Added 0 inventories.
 
779
        Added 0 revisions.
 
780
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
781
        True
 
782
        """
 
783
        from bzrlib.progress import ProgressBar
 
784
        try:
 
785
            set
 
786
        except NameError:
 
787
            from sets import Set as set
 
788
 
 
789
        pb = ProgressBar()
 
790
 
 
791
        pb.update('comparing histories')
 
792
        revision_ids = self.missing_revisions(other, stop_revision)
 
793
 
 
794
        if hasattr(other.revision_store, "prefetch"):
 
795
            other.revision_store.prefetch(revision_ids)
 
796
        if hasattr(other.inventory_store, "prefetch"):
 
797
            inventory_ids = [other.get_revision(r).inventory_id
 
798
                             for r in revision_ids]
 
799
            other.inventory_store.prefetch(inventory_ids)
 
800
                
 
801
        revisions = []
 
802
        needed_texts = set()
 
803
        i = 0
 
804
        for rev_id in revision_ids:
 
805
            i += 1
 
806
            pb.update('fetching revision', i, len(revision_ids))
 
807
            rev = other.get_revision(rev_id)
 
808
            revisions.append(rev)
 
809
            inv = other.get_inventory(str(rev.inventory_id))
 
810
            for key, entry in inv.iter_entries():
 
811
                if entry.text_id is None:
 
812
                    continue
 
813
                if entry.text_id not in self.text_store:
 
814
                    needed_texts.add(entry.text_id)
 
815
 
 
816
        pb.clear()
 
817
                    
 
818
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
819
        print "Added %d texts." % count 
 
820
        inventory_ids = [ f.inventory_id for f in revisions ]
 
821
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
822
                                                inventory_ids)
 
823
        print "Added %d inventories." % count 
 
824
        revision_ids = [ f.revision_id for f in revisions]
 
825
        count = self.revision_store.copy_multi(other.revision_store, 
 
826
                                               revision_ids)
 
827
        for revision_id in revision_ids:
 
828
            self.append_revision(revision_id)
 
829
        print "Added %d revisions." % count
 
830
                    
 
831
        
 
832
    def commit(self, *args, **kw):
 
833
        from bzrlib.commit import commit
 
834
        commit(self, *args, **kw)
759
835
        
760
836
 
761
837
    def lookup_revision(self, revno):
775
851
 
776
852
        `revision_id` may be None for the null revision, in which case
777
853
        an `EmptyTree` is returned."""
778
 
        self._need_readlock()
 
854
        from bzrlib.tree import EmptyTree, RevisionTree
 
855
        # TODO: refactor this to use an existing revision object
 
856
        # so we don't need to read it in twice.
779
857
        if revision_id == None:
780
858
            return EmptyTree()
781
859
        else:
793
871
        """Return `Tree` object for last revision.
794
872
 
795
873
        If there are no revisions yet, return an `EmptyTree`.
796
 
 
797
 
        >>> b = ScratchBranch(files=['foo'])
798
 
        >>> b.basis_tree().has_filename('foo')
799
 
        False
800
 
        >>> b.working_tree().has_filename('foo')
801
 
        True
802
 
        >>> b.add('foo')
803
 
        >>> b.commit('add foo')
804
 
        >>> b.basis_tree().has_filename('foo')
805
 
        True
806
874
        """
 
875
        from bzrlib.tree import EmptyTree, RevisionTree
807
876
        r = self.last_patch()
808
877
        if r == None:
809
878
            return EmptyTree()
817
886
 
818
887
        This can change the directory or the filename or both.
819
888
        """
820
 
        self._need_writelock()
821
 
        tree = self.working_tree()
822
 
        inv = tree.inventory
823
 
        if not tree.has_filename(from_rel):
824
 
            bailout("can't rename: old working file %r does not exist" % from_rel)
825
 
        if tree.has_filename(to_rel):
826
 
            bailout("can't rename: new working file %r already exists" % to_rel)
827
 
            
828
 
        file_id = inv.path2id(from_rel)
829
 
        if file_id == None:
830
 
            bailout("can't rename: old name %r is not versioned" % from_rel)
831
 
 
832
 
        if inv.path2id(to_rel):
833
 
            bailout("can't rename: new name %r is already versioned" % to_rel)
834
 
 
835
 
        to_dir, to_tail = os.path.split(to_rel)
836
 
        to_dir_id = inv.path2id(to_dir)
837
 
        if to_dir_id == None and to_dir != '':
838
 
            bailout("can't determine destination directory id for %r" % to_dir)
839
 
 
840
 
        mutter("rename_one:")
841
 
        mutter("  file_id    {%s}" % file_id)
842
 
        mutter("  from_rel   %r" % from_rel)
843
 
        mutter("  to_rel     %r" % to_rel)
844
 
        mutter("  to_dir     %r" % to_dir)
845
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
846
 
            
847
 
        inv.rename(file_id, to_dir_id, to_tail)
848
 
 
849
 
        print "%s => %s" % (from_rel, to_rel)
850
 
        
851
 
        from_abs = self.abspath(from_rel)
852
 
        to_abs = self.abspath(to_rel)
 
889
        self.lock_write()
853
890
        try:
854
 
            os.rename(from_abs, to_abs)
855
 
        except OSError, e:
856
 
            bailout("failed to rename %r to %r: %s"
857
 
                    % (from_abs, to_abs, e[1]),
858
 
                    ["rename rolled back"])
859
 
 
860
 
        self._write_inventory(inv)
861
 
            
 
891
            tree = self.working_tree()
 
892
            inv = tree.inventory
 
893
            if not tree.has_filename(from_rel):
 
894
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
895
            if tree.has_filename(to_rel):
 
896
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
897
 
 
898
            file_id = inv.path2id(from_rel)
 
899
            if file_id == None:
 
900
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
901
 
 
902
            if inv.path2id(to_rel):
 
903
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
904
 
 
905
            to_dir, to_tail = os.path.split(to_rel)
 
906
            to_dir_id = inv.path2id(to_dir)
 
907
            if to_dir_id == None and to_dir != '':
 
908
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
909
 
 
910
            mutter("rename_one:")
 
911
            mutter("  file_id    {%s}" % file_id)
 
912
            mutter("  from_rel   %r" % from_rel)
 
913
            mutter("  to_rel     %r" % to_rel)
 
914
            mutter("  to_dir     %r" % to_dir)
 
915
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
916
 
 
917
            inv.rename(file_id, to_dir_id, to_tail)
 
918
 
 
919
            print "%s => %s" % (from_rel, to_rel)
 
920
 
 
921
            from_abs = self.abspath(from_rel)
 
922
            to_abs = self.abspath(to_rel)
 
923
            try:
 
924
                os.rename(from_abs, to_abs)
 
925
            except OSError, e:
 
926
                raise BzrError("failed to rename %r to %r: %s"
 
927
                        % (from_abs, to_abs, e[1]),
 
928
                        ["rename rolled back"])
 
929
 
 
930
            self._write_inventory(inv)
 
931
        finally:
 
932
            self.unlock()
862
933
 
863
934
 
864
935
    def move(self, from_paths, to_name):
872
943
        Note that to_name is only the last component of the new name;
873
944
        this doesn't change the directory.
874
945
        """
875
 
        self._need_writelock()
876
 
        ## TODO: Option to move IDs only
877
 
        assert not isinstance(from_paths, basestring)
878
 
        tree = self.working_tree()
879
 
        inv = tree.inventory
880
 
        to_abs = self.abspath(to_name)
881
 
        if not isdir(to_abs):
882
 
            bailout("destination %r is not a directory" % to_abs)
883
 
        if not tree.has_filename(to_name):
884
 
            bailout("destination %r not in working directory" % to_abs)
885
 
        to_dir_id = inv.path2id(to_name)
886
 
        if to_dir_id == None and to_name != '':
887
 
            bailout("destination %r is not a versioned directory" % to_name)
888
 
        to_dir_ie = inv[to_dir_id]
889
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
890
 
            bailout("destination %r is not a directory" % to_abs)
891
 
 
892
 
        to_idpath = Set(inv.get_idpath(to_dir_id))
893
 
 
894
 
        for f in from_paths:
895
 
            if not tree.has_filename(f):
896
 
                bailout("%r does not exist in working tree" % f)
897
 
            f_id = inv.path2id(f)
898
 
            if f_id == None:
899
 
                bailout("%r is not versioned" % f)
900
 
            name_tail = splitpath(f)[-1]
901
 
            dest_path = appendpath(to_name, name_tail)
902
 
            if tree.has_filename(dest_path):
903
 
                bailout("destination %r already exists" % dest_path)
904
 
            if f_id in to_idpath:
905
 
                bailout("can't move %r to a subdirectory of itself" % f)
906
 
 
907
 
        # OK, so there's a race here, it's possible that someone will
908
 
        # create a file in this interval and then the rename might be
909
 
        # left half-done.  But we should have caught most problems.
910
 
 
911
 
        for f in from_paths:
912
 
            name_tail = splitpath(f)[-1]
913
 
            dest_path = appendpath(to_name, name_tail)
914
 
            print "%s => %s" % (f, dest_path)
915
 
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
916
 
            try:
917
 
                os.rename(self.abspath(f), self.abspath(dest_path))
918
 
            except OSError, e:
919
 
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
920
 
                        ["rename rolled back"])
921
 
 
922
 
        self._write_inventory(inv)
923
 
 
 
946
        self.lock_write()
 
947
        try:
 
948
            ## TODO: Option to move IDs only
 
949
            assert not isinstance(from_paths, basestring)
 
950
            tree = self.working_tree()
 
951
            inv = tree.inventory
 
952
            to_abs = self.abspath(to_name)
 
953
            if not isdir(to_abs):
 
954
                raise BzrError("destination %r is not a directory" % to_abs)
 
955
            if not tree.has_filename(to_name):
 
956
                raise BzrError("destination %r not in working directory" % to_abs)
 
957
            to_dir_id = inv.path2id(to_name)
 
958
            if to_dir_id == None and to_name != '':
 
959
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
960
            to_dir_ie = inv[to_dir_id]
 
961
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
962
                raise BzrError("destination %r is not a directory" % to_abs)
 
963
 
 
964
            to_idpath = inv.get_idpath(to_dir_id)
 
965
 
 
966
            for f in from_paths:
 
967
                if not tree.has_filename(f):
 
968
                    raise BzrError("%r does not exist in working tree" % f)
 
969
                f_id = inv.path2id(f)
 
970
                if f_id == None:
 
971
                    raise BzrError("%r is not versioned" % f)
 
972
                name_tail = splitpath(f)[-1]
 
973
                dest_path = appendpath(to_name, name_tail)
 
974
                if tree.has_filename(dest_path):
 
975
                    raise BzrError("destination %r already exists" % dest_path)
 
976
                if f_id in to_idpath:
 
977
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
978
 
 
979
            # OK, so there's a race here, it's possible that someone will
 
980
            # create a file in this interval and then the rename might be
 
981
            # left half-done.  But we should have caught most problems.
 
982
 
 
983
            for f in from_paths:
 
984
                name_tail = splitpath(f)[-1]
 
985
                dest_path = appendpath(to_name, name_tail)
 
986
                print "%s => %s" % (f, dest_path)
 
987
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
988
                try:
 
989
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
990
                except OSError, e:
 
991
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
992
                            ["rename rolled back"])
 
993
 
 
994
            self._write_inventory(inv)
 
995
        finally:
 
996
            self.unlock()
 
997
 
 
998
 
 
999
    def revert(self, filenames, old_tree=None, backups=True):
 
1000
        """Restore selected files to the versions from a previous tree.
 
1001
 
 
1002
        backups
 
1003
            If true (default) backups are made of files before
 
1004
            they're renamed.
 
1005
        """
 
1006
        from bzrlib.errors import NotVersionedError, BzrError
 
1007
        from bzrlib.atomicfile import AtomicFile
 
1008
        from bzrlib.osutils import backup_file
 
1009
        
 
1010
        inv = self.read_working_inventory()
 
1011
        if old_tree is None:
 
1012
            old_tree = self.basis_tree()
 
1013
        old_inv = old_tree.inventory
 
1014
 
 
1015
        nids = []
 
1016
        for fn in filenames:
 
1017
            file_id = inv.path2id(fn)
 
1018
            if not file_id:
 
1019
                raise NotVersionedError("not a versioned file", fn)
 
1020
            if not old_inv.has_id(file_id):
 
1021
                raise BzrError("file not present in old tree", fn, file_id)
 
1022
            nids.append((fn, file_id))
 
1023
            
 
1024
        # TODO: Rename back if it was previously at a different location
 
1025
 
 
1026
        # TODO: If given a directory, restore the entire contents from
 
1027
        # the previous version.
 
1028
 
 
1029
        # TODO: Make a backup to a temporary file.
 
1030
 
 
1031
        # TODO: If the file previously didn't exist, delete it?
 
1032
        for fn, file_id in nids:
 
1033
            backup_file(fn)
 
1034
            
 
1035
            f = AtomicFile(fn, 'wb')
 
1036
            try:
 
1037
                f.write(old_tree.get_file(file_id).read())
 
1038
                f.commit()
 
1039
            finally:
 
1040
                f.close()
 
1041
 
 
1042
 
 
1043
    def pending_merges(self):
 
1044
        """Return a list of pending merges.
 
1045
 
 
1046
        These are revisions that have been merged into the working
 
1047
        directory but not yet committed.
 
1048
        """
 
1049
        cfn = self.controlfilename('pending-merges')
 
1050
        if not os.path.exists(cfn):
 
1051
            return []
 
1052
        p = []
 
1053
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1054
            p.append(l.rstrip('\n'))
 
1055
        return p
 
1056
 
 
1057
 
 
1058
    def add_pending_merge(self, revision_id):
 
1059
        from bzrlib.revision import validate_revision_id
 
1060
 
 
1061
        validate_revision_id(revision_id)
 
1062
 
 
1063
        p = self.pending_merges()
 
1064
        if revision_id in p:
 
1065
            return
 
1066
        p.append(revision_id)
 
1067
        self.set_pending_merges(p)
 
1068
 
 
1069
 
 
1070
    def set_pending_merges(self, rev_list):
 
1071
        from bzrlib.atomicfile import AtomicFile
 
1072
        self.lock_write()
 
1073
        try:
 
1074
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1075
            try:
 
1076
                for l in rev_list:
 
1077
                    print >>f, l
 
1078
                f.commit()
 
1079
            finally:
 
1080
                f.close()
 
1081
        finally:
 
1082
            self.unlock()
924
1083
 
925
1084
 
926
1085
 
935
1094
    >>> isdir(bd)
936
1095
    False
937
1096
    """
938
 
    def __init__(self, files=[], dirs=[]):
 
1097
    def __init__(self, files=[], dirs=[], base=None):
939
1098
        """Make a test branch.
940
1099
 
941
1100
        This creates a temporary directory and runs init-tree in it.
942
1101
 
943
1102
        If any files are listed, they are created in the working copy.
944
1103
        """
945
 
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
1104
        from tempfile import mkdtemp
 
1105
        init = False
 
1106
        if base is None:
 
1107
            base = mkdtemp()
 
1108
            init = True
 
1109
        Branch.__init__(self, base, init=init)
946
1110
        for d in dirs:
947
1111
            os.mkdir(self.abspath(d))
948
1112
            
950
1114
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
951
1115
 
952
1116
 
 
1117
    def clone(self):
 
1118
        """
 
1119
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1120
        >>> clone = orig.clone()
 
1121
        >>> os.path.samefile(orig.base, clone.base)
 
1122
        False
 
1123
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1124
        True
 
1125
        """
 
1126
        from shutil import copytree
 
1127
        from tempfile import mkdtemp
 
1128
        base = mkdtemp()
 
1129
        os.rmdir(base)
 
1130
        copytree(self.base, base, symlinks=True)
 
1131
        return ScratchBranch(base=base)
 
1132
        
953
1133
    def __del__(self):
954
1134
        self.destroy()
955
1135
 
956
1136
    def destroy(self):
957
1137
        """Destroy the test branch, removing the scratch directory."""
 
1138
        from shutil import rmtree
958
1139
        try:
959
 
            mutter("delete ScratchBranch %s" % self.base)
960
 
            shutil.rmtree(self.base)
 
1140
            if self.base:
 
1141
                mutter("delete ScratchBranch %s" % self.base)
 
1142
                rmtree(self.base)
961
1143
        except OSError, e:
962
1144
            # Work around for shutil.rmtree failing on Windows when
963
1145
            # readonly files are encountered
965
1147
            for root, dirs, files in os.walk(self.base, topdown=False):
966
1148
                for name in files:
967
1149
                    os.chmod(os.path.join(root, name), 0700)
968
 
            shutil.rmtree(self.base)
 
1150
            rmtree(self.base)
969
1151
        self.base = None
970
1152
 
971
1153
    
989
1171
 
990
1172
 
991
1173
 
992
 
def _gen_revision_id(when):
993
 
    """Return new revision-id."""
994
 
    s = '%s-%s-' % (user_email(), compact_date(when))
995
 
    s += hexlify(rand_bytes(8))
996
 
    return s
997
 
 
998
 
 
999
1174
def gen_file_id(name):
1000
1175
    """Return new file id.
1001
1176
 
1002
1177
    This should probably generate proper UUIDs, but for the moment we
1003
1178
    cope with just randomness because running uuidgen every time is
1004
1179
    slow."""
 
1180
    import re
 
1181
    from binascii import hexlify
 
1182
    from time import time
 
1183
 
 
1184
    # get last component
1005
1185
    idx = name.rfind('/')
1006
1186
    if idx != -1:
1007
1187
        name = name[idx+1 : ]
1009
1189
    if idx != -1:
1010
1190
        name = name[idx+1 : ]
1011
1191
 
 
1192
    # make it not a hidden file
1012
1193
    name = name.lstrip('.')
1013
1194
 
 
1195
    # remove any wierd characters; we don't escape them but rather
 
1196
    # just pull them out
 
1197
    name = re.sub(r'[^\w.]', '', name)
 
1198
 
1014
1199
    s = hexlify(rand_bytes(8))
1015
 
    return '-'.join((name, compact_date(time.time()), s))
 
1200
    return '-'.join((name, compact_date(time()), s))