~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-07-11 05:46:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050711054655-47ea25e1f75a8813
- ignore tmp dir

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