~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-05 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated

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