~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-09 06:21:44 UTC
  • Revision ID: mbp@sourcefrog.net-20050409062144-e47a4b64106e4c21af99beaf
debugĀ output

Show diffs side-by-side

added added

removed removed

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