~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-07-04 08:06:51 UTC
  • Revision ID: mbp@sourcefrog.net-20050704080651-6ecec49164359e48
- track pending-merges

- unit tests for this

Show diffs side-by-side

added added

removed removed

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