~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:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
 
1
# Copyright (C) 2005 Canonical Ltd
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
17
 
19
 
from sets import Set
20
 
 
21
 
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
22
 
import traceback, socket, fnmatch, difflib, time
23
 
from binascii import hexlify
 
18
import sys, os
24
19
 
25
20
import bzrlib
26
 
from inventory import Inventory
27
 
from trace import mutter, note
28
 
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
29
 
from inventory import InventoryEntry, Inventory
30
 
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
31
 
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
32
 
     joinpath, sha_string, file_kind, local_time_offset
33
 
from store import ImmutableStore
34
 
from revision import Revision
35
 
from errors import bailout
36
 
from textui import show_status
37
 
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
38
25
 
39
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
40
27
## TODO: Maybe include checks for common corruption of newlines, etc?
41
28
 
42
29
 
43
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
 
 
84
def find_branch_root(f=None):
 
85
    """Find the branch root enclosing f, or pwd.
 
86
 
 
87
    f may be a filename or a URL.
 
88
 
 
89
    It is not necessary that f exists.
 
90
 
 
91
    Basically we keep looking up until we find the control directory or
 
92
    run into the root."""
 
93
    if f == None:
 
94
        f = os.getcwd()
 
95
    elif hasattr(os.path, 'realpath'):
 
96
        f = os.path.realpath(f)
 
97
    else:
 
98
        f = os.path.abspath(f)
 
99
    if not os.path.exists(f):
 
100
        raise BzrError('%r does not exist' % f)
 
101
        
 
102
 
 
103
    orig_f = f
 
104
 
 
105
    while True:
 
106
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
107
            return f
 
108
        head, tail = os.path.split(f)
 
109
        if head == f:
 
110
            # reached the root, whatever that may be
 
111
            raise BzrError('%r is not in a branch' % orig_f)
 
112
        f = head
 
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)
44
127
 
45
128
 
46
129
######################################################################
47
130
# branch objects
48
131
 
49
 
class Branch:
 
132
class Branch(object):
50
133
    """Branch holding a history of revisions.
51
134
 
52
 
    :todo: Perhaps use different stores for different classes of object,
53
 
           so that we can keep track of how much space each one uses,
54
 
           or garbage-collect them.
55
 
 
56
 
    :todo: Add a RemoteBranch subclass.  For the basic case of read-only
57
 
           HTTP access this should be very easy by, 
58
 
           just redirecting controlfile access into HTTP requests.
59
 
           We would need a RemoteStore working similarly.
60
 
 
61
 
    :todo: Keep the on-disk branch locked while the object exists.
62
 
 
63
 
    :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.
64
147
    """
65
 
    def __init__(self, base, init=False):
 
148
    base = None
 
149
    _lock_mode = None
 
150
    _lock_count = None
 
151
    _lock = None
 
152
    
 
153
    def __init__(self, base, init=False, find_root=True):
66
154
        """Create new branch object at a particular location.
67
155
 
68
 
        :param base: Base directory for the branch.
69
 
 
70
 
        :param init: If True, create new control files in a previously
 
156
        base -- Base directory for the branch.
 
157
        
 
158
        init -- If True, create new control files in a previously
71
159
             unversioned directory.  If False, the branch must already
72
160
             be versioned.
73
161
 
 
162
        find_root -- If true and init is false, find the root of the
 
163
             existing branch containing base.
 
164
 
74
165
        In the test suite, creation of new trees is tested using the
75
166
        `ScratchBranch` class.
76
167
        """
77
 
        self.base = os.path.realpath(base)
 
168
        from bzrlib.store import ImmutableStore
78
169
        if init:
 
170
            self.base = os.path.realpath(base)
79
171
            self._make_control()
 
172
        elif find_root:
 
173
            self.base = find_branch_root(base)
80
174
        else:
 
175
            self.base = os.path.realpath(base)
81
176
            if not isdir(self.controlfilename('.')):
82
 
                bailout("not a bzr branch: %s" % quotefn(base),
83
 
                        ['use "bzr init" to initialize a new working tree',
84
 
                         'current bzr can only operate from top-of-tree'])
85
 
            self._check_format()
 
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'])
 
181
        self._check_format()
86
182
 
87
183
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
88
184
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
96
192
    __repr__ = __str__
97
193
 
98
194
 
99
 
    def _rel(self, name):
100
 
        """Return filename relative to branch top"""
 
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
    def abspath(self, name):
 
247
        """Return absolute filename for something in the branch"""
101
248
        return os.path.join(self.base, name)
102
 
        
 
249
 
 
250
 
 
251
    def relpath(self, path):
 
252
        """Return path relative to this branch of something inside it.
 
253
 
 
254
        Raises an error if path is not in this branch."""
 
255
        return _relpath(self.base, path)
 
256
 
103
257
 
104
258
    def controlfilename(self, file_or_path):
105
259
        """Return location relative to branch."""
106
 
        if isinstance(file_or_path, types.StringTypes):
 
260
        if isinstance(file_or_path, basestring):
107
261
            file_or_path = [file_or_path]
108
262
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
109
263
 
110
264
 
111
265
    def controlfile(self, file_or_path, mode='r'):
112
 
        """Open a control file for this branch"""
113
 
        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
 
114
290
 
115
291
 
116
292
    def _make_control(self):
 
293
        from bzrlib.inventory import Inventory
 
294
        from bzrlib.xml import pack_xml
 
295
        
117
296
        os.mkdir(self.controlfilename([]))
118
297
        self.controlfile('README', 'w').write(
119
298
            "This is a Bazaar-NG control directory.\n"
120
 
            "Do not change any files in this directory.")
 
299
            "Do not change any files in this directory.\n")
121
300
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
122
301
        for d in ('text-store', 'inventory-store', 'revision-store'):
123
302
            os.mkdir(self.controlfilename(d))
124
303
        for f in ('revision-history', 'merged-patches',
125
 
                  'pending-merged-patches', 'branch-name'):
 
304
                  'pending-merged-patches', 'branch-name',
 
305
                  'branch-lock',
 
306
                  'pending-merges'):
126
307
            self.controlfile(f, 'w').write('')
127
308
        mutter('created control directory in ' + self.base)
128
 
        Inventory().write_xml(self.controlfile('inventory','w'))
 
309
 
 
310
        pack_xml(Inventory(), self.controlfile('inventory','w'))
129
311
 
130
312
 
131
313
    def _check_format(self):
135
317
 
136
318
        In the future, we might need different in-memory Branch
137
319
        classes to support downlevel branches.  But not yet.
138
 
        """        
139
 
        # read in binary mode to detect newline wierdness.
140
 
        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', '')
141
326
        if fmt != BZR_BRANCH_FORMAT:
142
 
            bailout('sorry, branch format %r not supported' % fmt,
143
 
                    ['use a different bzr version',
144
 
                     '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
 
145
331
 
146
332
 
147
333
    def read_working_inventory(self):
148
334
        """Read the working inventory."""
149
 
        before = time.time()
150
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
151
 
        mutter("loaded inventory of %d items in %f"
152
 
               % (len(inv), time.time() - before))
153
 
        return inv
154
 
 
 
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
            
155
351
 
156
352
    def _write_inventory(self, inv):
157
353
        """Update the working inventory.
159
355
        That is to say, the inventory describing changes underway, that
160
356
        will be committed to the next revision.
161
357
        """
162
 
        ## TODO: factor out to atomicfile?  is rename safe on windows?
163
 
        tmpfname = self.controlfilename('inventory.tmp')
164
 
        tmpf = file(tmpfname, 'w')
165
 
        inv.write_xml(tmpf)
166
 
        tmpf.close()
167
 
        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
        
168
372
        mutter('wrote working inventory')
169
 
 
 
373
            
170
374
 
171
375
    inventory = property(read_working_inventory, _write_inventory, None,
172
376
                         """Inventory for the working copy.""")
173
377
 
174
378
 
175
 
    def add(self, files, verbose=False):
 
379
    def add(self, files, verbose=False, ids=None):
176
380
        """Make files versioned.
177
381
 
 
382
        Note that the command line normally calls smart_add instead.
 
383
 
178
384
        This puts the files in the Added state, so that they will be
179
385
        recorded by the next commit.
180
386
 
181
 
        :todo: Perhaps have an option to add the ids even if the files do
182
 
               not (yet) exist.
183
 
 
184
 
        :todo: Perhaps return the ids of the files?  But then again it
185
 
               is easy to retrieve them if they're needed.
186
 
 
187
 
        :todo: Option to specify file id.
188
 
 
189
 
        :todo: Adding a directory should optionally recurse down and
190
 
               add all non-ignored children.  Perhaps do that in a
191
 
               higher-level method.
192
 
 
193
 
        >>> b = ScratchBranch(files=['foo'])
194
 
        >>> 'foo' in b.unknowns()
195
 
        True
196
 
        >>> b.show_status()
197
 
        ?       foo
198
 
        >>> b.add('foo')
199
 
        >>> 'foo' in b.unknowns()
200
 
        False
201
 
        >>> bool(b.inventory.path2id('foo'))
202
 
        True
203
 
        >>> b.show_status()
204
 
        A       foo
205
 
 
206
 
        >>> b.add('foo')
207
 
        Traceback (most recent call last):
208
 
        ...
209
 
        BzrError: ('foo is already versioned', [])
210
 
 
211
 
        >>> b.add(['nothere'])
212
 
        Traceback (most recent call last):
213
 
        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.
214
404
        """
215
 
 
 
405
        from bzrlib.textui import show_status
216
406
        # TODO: Re-adding a file that is removed in the working copy
217
407
        # should probably put it back with the previous ID.
218
 
        if isinstance(files, types.StringTypes):
 
408
        if isinstance(files, basestring):
 
409
            assert(ids is None or isinstance(ids, basestring))
219
410
            files = [files]
220
 
        
221
 
        inv = self.read_working_inventory()
222
 
        for f in files:
223
 
            if is_control_file(f):
224
 
                bailout("cannot add control file %s" % quotefn(f))
225
 
 
226
 
            fp = splitpath(f)
227
 
 
228
 
            if len(fp) == 0:
229
 
                bailout("cannot add top-level %r" % f)
230
 
                
231
 
            fullpath = os.path.normpath(self._rel(f))
232
 
 
233
 
            if isfile(fullpath):
234
 
                kind = 'file'
235
 
            elif isdir(fullpath):
236
 
                kind = 'directory'
237
 
            else:
238
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
239
 
 
240
 
            if len(fp) > 1:
241
 
                parent_name = joinpath(fp[:-1])
242
 
                mutter("lookup parent %r" % parent_name)
243
 
                parent_id = inv.path2id(parent_name)
244
 
                if parent_id == None:
245
 
                    bailout("cannot add: parent %r is not versioned"
246
 
                            % joinpath(fp[:-1]))
247
 
            else:
248
 
                parent_id = None
249
 
 
250
 
            file_id = _gen_file_id(fp[-1])
251
 
            inv.add(InventoryEntry(file_id, fp[-1], kind=kind, parent_id=parent_id))
252
 
            if verbose:
253
 
                show_status('A', kind, quotefn(f))
254
 
                
255
 
            mutter("add file %s file_id:{%s} kind=%r parent_id={%s}"
256
 
                   % (f, file_id, kind, parent_id))
257
 
        self._write_inventory(inv)
258
 
 
 
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()
259
468
 
260
469
 
261
470
    def remove(self, files, verbose=False):
263
472
 
264
473
        This does not remove their text.  This does not run on 
265
474
 
266
 
        :todo: Refuse to remove modified files unless --force is given?
267
 
 
268
 
        >>> b = ScratchBranch(files=['foo'])
269
 
        >>> b.add('foo')
270
 
        >>> b.inventory.has_filename('foo')
271
 
        True
272
 
        >>> b.remove('foo')
273
 
        >>> b.working_tree().has_filename('foo')
274
 
        True
275
 
        >>> b.inventory.has_filename('foo')
276
 
        False
277
 
        
278
 
        >>> b = ScratchBranch(files=['foo'])
279
 
        >>> b.add('foo')
280
 
        >>> b.commit('one')
281
 
        >>> b.remove('foo')
282
 
        >>> b.commit('two')
283
 
        >>> b.inventory.has_filename('foo') 
284
 
        False
285
 
        >>> b.basis_tree().has_filename('foo') 
286
 
        False
287
 
        >>> b.working_tree().has_filename('foo') 
288
 
        True
289
 
 
290
 
        :todo: Do something useful with directories.
291
 
 
292
 
        :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
293
480
        removing may be useful and the user can just use use rm, and
294
481
        is the opposite of add.  Removing it is consistent with most
295
482
        other tools.  Maybe an option.
296
483
        """
 
484
        from bzrlib.textui import show_status
297
485
        ## TODO: Normalize names
298
486
        ## TODO: Remove nested loops; better scalability
299
 
 
300
 
        if isinstance(files, types.StringTypes):
 
487
        if isinstance(files, basestring):
301
488
            files = [files]
302
 
        
303
 
        tree = self.working_tree()
304
 
        inv = tree.inventory
305
 
 
306
 
        # do this before any modifications
307
 
        for f in files:
308
 
            fid = inv.path2id(f)
309
 
            if not fid:
310
 
                bailout("cannot remove unversioned file %s" % quotefn(f))
311
 
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
312
 
            if verbose:
313
 
                # having remove it, it must be either ignored or unknown
314
 
                if tree.is_ignored(f):
315
 
                    new_status = 'I'
316
 
                else:
317
 
                    new_status = '?'
318
 
                show_status(new_status, inv[fid].kind, quotefn(f))
319
 
            del inv[fid]
320
 
 
 
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))
321
525
        self._write_inventory(inv)
322
526
 
323
527
 
340
544
        return self.working_tree().unknowns()
341
545
 
342
546
 
343
 
    def commit(self, message, timestamp=None, timezone=None,
344
 
               committer=None,
345
 
               verbose=False):
346
 
        """Commit working copy as a new revision.
347
 
        
348
 
        The basic approach is to add all the file texts into the
349
 
        store, then the inventory, then make a new revision pointing
350
 
        to that inventory and store that.
351
 
        
352
 
        This is not quite safe if the working copy changes during the
353
 
        commit; for the moment that is simply not allowed.  A better
354
 
        approach is to make a temporary copy of the files before
355
 
        computing their hashes, and then add those hashes in turn to
356
 
        the inventory.  This should mean at least that there are no
357
 
        broken hash pointers.  There is no way we can get a snapshot
358
 
        of the whole directory at an instant.  This would also have to
359
 
        be robust against files disappearing, moving, etc.  So the
360
 
        whole thing is a bit hard.
361
 
 
362
 
        :param timestamp: if not None, seconds-since-epoch for a
363
 
             postdated/predated commit.
364
 
        """
365
 
 
366
 
        ## TODO: Show branch names
367
 
 
368
 
        # TODO: Don't commit if there are no changes, unless forced?
369
 
 
370
 
        # First walk over the working inventory; and both update that
371
 
        # and also build a new revision inventory.  The revision
372
 
        # inventory needs to hold the text-id, sha1 and size of the
373
 
        # actual file versions committed in the revision.  (These are
374
 
        # not present in the working inventory.)  We also need to
375
 
        # detect missing/deleted files, and remove them from the
376
 
        # working inventory.
377
 
 
378
 
        work_inv = self.read_working_inventory()
379
 
        inv = Inventory()
380
 
        basis = self.basis_tree()
381
 
        basis_inv = basis.inventory
382
 
        missing_ids = []
383
 
        for path, entry in work_inv.iter_entries():
384
 
            ## TODO: Cope with files that have gone missing.
385
 
 
386
 
            ## TODO: Check that the file kind has not changed from the previous
387
 
            ## revision of this file (if any).
388
 
 
389
 
            entry = entry.copy()
390
 
 
391
 
            p = self._rel(path)
392
 
            file_id = entry.file_id
393
 
            mutter('commit prep file %s, id %r ' % (p, file_id))
394
 
 
395
 
            if not os.path.exists(p):
396
 
                mutter("    file is missing, removing from inventory")
397
 
                if verbose:
398
 
                    show_status('D', entry.kind, quotefn(path))
399
 
                missing_ids.append(file_id)
400
 
                continue
401
 
 
402
 
            # TODO: Handle files that have been deleted
403
 
 
404
 
            # TODO: Maybe a special case for empty files?  Seems a
405
 
            # waste to store them many times.
406
 
 
407
 
            inv.add(entry)
408
 
 
409
 
            if basis_inv.has_id(file_id):
410
 
                old_kind = basis_inv[file_id].kind
411
 
                if old_kind != entry.kind:
412
 
                    bailout("entry %r changed kind from %r to %r"
413
 
                            % (file_id, old_kind, entry.kind))
414
 
 
415
 
            if entry.kind == 'directory':
416
 
                if not isdir(p):
417
 
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
418
 
            elif entry.kind == 'file':
419
 
                if not isfile(p):
420
 
                    bailout("%s is entered as file but is not a file" % quotefn(p))
421
 
 
422
 
                content = file(p, 'rb').read()
423
 
 
424
 
                entry.text_sha1 = sha_string(content)
425
 
                entry.text_size = len(content)
426
 
 
427
 
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
428
 
                if (old_ie
429
 
                    and (old_ie.text_size == entry.text_size)
430
 
                    and (old_ie.text_sha1 == entry.text_sha1)):
431
 
                    ## assert content == basis.get_file(file_id).read()
432
 
                    entry.text_id = basis_inv[file_id].text_id
433
 
                    mutter('    unchanged from previous text_id {%s}' %
434
 
                           entry.text_id)
435
 
                    
436
 
                else:
437
 
                    entry.text_id = _gen_file_id(entry.name)
438
 
                    self.text_store.add(content, entry.text_id)
439
 
                    mutter('    stored with text_id {%s}' % entry.text_id)
440
 
                    if verbose:
441
 
                        if not old_ie:
442
 
                            state = 'A'
443
 
                        elif (old_ie.name == entry.name
444
 
                              and old_ie.parent_id == entry.parent_id):
445
 
                            state = 'R'
446
 
                        else:
447
 
                            state = 'M'
448
 
 
449
 
                        show_status(state, entry.kind, quotefn(path))
450
 
 
451
 
        for file_id in missing_ids:
452
 
            # have to do this later so we don't mess up the iterator.
453
 
            # since parents may be removed before their children we
454
 
            # have to test.
455
 
 
456
 
            # FIXME: There's probably a better way to do this; perhaps
457
 
            # the workingtree should know how to filter itself.
458
 
            if work_inv.has_id(file_id):
459
 
                del work_inv[file_id]
460
 
 
461
 
 
462
 
        inv_id = rev_id = _gen_revision_id(time.time())
463
 
        
464
 
        inv_tmp = tempfile.TemporaryFile()
465
 
        inv.write_xml(inv_tmp)
466
 
        inv_tmp.seek(0)
467
 
        self.inventory_store.add(inv_tmp, inv_id)
468
 
        mutter('new inventory_id is {%s}' % inv_id)
469
 
 
470
 
        self._write_inventory(work_inv)
471
 
 
472
 
        if timestamp == None:
473
 
            timestamp = time.time()
474
 
 
475
 
        if committer == None:
476
 
            committer = username()
477
 
 
478
 
        if timezone == None:
479
 
            timezone = local_time_offset()
480
 
 
481
 
        mutter("building commit log message")
482
 
        rev = Revision(timestamp=timestamp,
483
 
                       timezone=timezone,
484
 
                       committer=committer,
485
 
                       precursor = self.last_patch(),
486
 
                       message = message,
487
 
                       inventory_id=inv_id,
488
 
                       revision_id=rev_id)
489
 
 
490
 
        rev_tmp = tempfile.TemporaryFile()
491
 
        rev.write_xml(rev_tmp)
492
 
        rev_tmp.seek(0)
493
 
        self.revision_store.add(rev_tmp, rev_id)
494
 
        mutter("new revision_id is {%s}" % rev_id)
495
 
        
496
 
        ## XXX: Everything up to here can simply be orphaned if we abort
497
 
        ## the commit; it will leave junk files behind but that doesn't
498
 
        ## matter.
499
 
 
500
 
        ## TODO: Read back the just-generated changeset, and make sure it
501
 
        ## applies and recreates the right state.
502
 
 
503
 
        ## TODO: Also calculate and store the inventory SHA1
504
 
        mutter("committing patch r%d" % (self.revno() + 1))
505
 
 
506
 
        mutter("append to revision-history")
507
 
        self.controlfile('revision-history', 'at').write(rev_id + '\n')
508
 
 
509
 
        mutter("done!")
 
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()
510
560
 
511
561
 
512
562
    def get_revision(self, revision_id):
513
563
        """Return the Revision object for a named revision"""
514
 
        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
            
515
575
        assert r.revision_id == revision_id
516
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])
517
588
 
518
589
 
519
590
    def get_inventory(self, inventory_id):
520
591
        """Get Inventory object by hash.
521
592
 
522
 
        :todo: Perhaps for this and similar methods, take a revision
 
593
        TODO: Perhaps for this and similar methods, take a revision
523
594
               parameter which can be either an integer revno or a
524
595
               string hash."""
525
 
        i = Inventory.read_xml(self.inventory_store[inventory_id])
526
 
        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])
527
606
 
528
607
 
529
608
    def get_revision_inventory(self, revision_id):
530
609
        """Return inventory of a past revision."""
531
610
        if revision_id == None:
 
611
            from bzrlib.inventory import Inventory
532
612
            return Inventory()
533
613
        else:
534
614
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
540
620
        >>> ScratchBranch().revision_history()
541
621
        []
542
622
        """
543
 
        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)
544
695
 
545
696
 
546
697
    def revno(self):
548
699
 
549
700
        That is equivalent to the number of revisions committed to
550
701
        this branch.
551
 
 
552
 
        >>> b = ScratchBranch()
553
 
        >>> b.revno()
554
 
        0
555
 
        >>> b.commit('no foo')
556
 
        >>> b.revno()
557
 
        1
558
702
        """
559
703
        return len(self.revision_history())
560
704
 
561
705
 
562
706
    def last_patch(self):
563
707
        """Return last patch hash, or None if no history.
564
 
 
565
 
        >>> ScratchBranch().last_patch() == None
566
 
        True
567
708
        """
568
709
        ph = self.revision_history()
569
710
        if ph:
570
711
            return ph[-1]
571
 
 
 
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
        
572
836
 
573
837
    def lookup_revision(self, revno):
574
838
        """Return revision hash for revision number."""
579
843
            # list is 0-based; revisions are 1-based
580
844
            return self.revision_history()[revno-1]
581
845
        except IndexError:
582
 
            bailout("no such revision %s" % revno)
 
846
            raise BzrError("no such revision %s" % revno)
583
847
 
584
848
 
585
849
    def revision_tree(self, revision_id):
587
851
 
588
852
        `revision_id` may be None for the null revision, in which case
589
853
        an `EmptyTree` is returned."""
590
 
 
 
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.
591
857
        if revision_id == None:
592
858
            return EmptyTree()
593
859
        else:
597
863
 
598
864
    def working_tree(self):
599
865
        """Return a `Tree` for the working copy."""
 
866
        from workingtree import WorkingTree
600
867
        return WorkingTree(self.base, self.read_working_inventory())
601
868
 
602
869
 
604
871
        """Return `Tree` object for last revision.
605
872
 
606
873
        If there are no revisions yet, return an `EmptyTree`.
607
 
 
608
 
        >>> b = ScratchBranch(files=['foo'])
609
 
        >>> b.basis_tree().has_filename('foo')
610
 
        False
611
 
        >>> b.working_tree().has_filename('foo')
612
 
        True
613
 
        >>> b.add('foo')
614
 
        >>> b.commit('add foo')
615
 
        >>> b.basis_tree().has_filename('foo')
616
 
        True
617
874
        """
 
875
        from bzrlib.tree import EmptyTree, RevisionTree
618
876
        r = self.last_patch()
619
877
        if r == None:
620
878
            return EmptyTree()
623
881
 
624
882
 
625
883
 
626
 
    def write_log(self, show_timezone='original'):
627
 
        """Write out human-readable log of commits to this branch
628
 
 
629
 
        :param utc: If true, show dates in universal time, not local time."""
630
 
        ## TODO: Option to choose either original, utc or local timezone
631
 
        revno = 1
632
 
        precursor = None
633
 
        for p in self.revision_history():
634
 
            print '-' * 40
635
 
            print 'revno:', revno
636
 
            ## TODO: Show hash if --id is given.
637
 
            ##print 'revision-hash:', p
638
 
            rev = self.get_revision(p)
639
 
            print 'committer:', rev.committer
640
 
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
641
 
                                                 show_timezone))
642
 
 
643
 
            ## opportunistic consistency check, same as check_patch_chaining
644
 
            if rev.precursor != precursor:
645
 
                bailout("mismatched precursor!")
646
 
 
647
 
            print 'message:'
648
 
            if not rev.message:
649
 
                print '  (no message)'
650
 
            else:
651
 
                for l in rev.message.split('\n'):
652
 
                    print '  ' + l
653
 
 
654
 
            revno += 1
655
 
            precursor = p
656
 
 
657
 
 
658
 
 
659
 
    def show_status(branch, show_all=False):
660
 
        """Display single-line status for non-ignored working files.
661
 
 
662
 
        The list is show sorted in order by file name.
663
 
 
664
 
        >>> b = ScratchBranch(files=['foo', 'foo~'])
665
 
        >>> b.show_status()
666
 
        ?       foo
667
 
        >>> b.add('foo')
668
 
        >>> b.show_status()
669
 
        A       foo
670
 
        >>> b.commit("add foo")
671
 
        >>> b.show_status()
672
 
        >>> os.unlink(b._rel('foo'))
673
 
        >>> b.show_status()
674
 
        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
675
1009
        
676
 
 
677
 
        :todo: Get state for single files.
678
 
 
679
 
        :todo: Perhaps show a slash at the end of directory names.        
680
 
 
 
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.
681
1048
        """
682
 
 
683
 
        # We have to build everything into a list first so that it can
684
 
        # sorted by name, incorporating all the different sources.
685
 
 
686
 
        # FIXME: Rather than getting things in random order and then sorting,
687
 
        # just step through in order.
688
 
 
689
 
        # Interesting case: the old ID for a file has been removed,
690
 
        # but a new file has been created under that name.
691
 
 
692
 
        old = branch.basis_tree()
693
 
        old_inv = old.inventory
694
 
        new = branch.working_tree()
695
 
        new_inv = new.inventory
696
 
 
697
 
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
698
 
            if fs == 'R':
699
 
                show_status(fs, kind,
700
 
                            oldname + ' => ' + newname)
701
 
            elif fs == 'A' or fs == 'M':
702
 
                show_status(fs, kind, newname)
703
 
            elif fs == 'D':
704
 
                show_status(fs, kind, oldname)
705
 
            elif fs == '.':
706
 
                if show_all:
707
 
                    show_status(fs, kind, newname)
708
 
            elif fs == 'I':
709
 
                if show_all:
710
 
                    show_status(fs, kind, newname)
711
 
            elif fs == '?':
712
 
                show_status(fs, kind, newname)
713
 
            else:
714
 
                bailout("wierd file state %r" % ((fs, fid),))
715
 
                
 
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
 
716
1084
 
717
1085
 
718
1086
class ScratchBranch(Branch):
722
1090
    >>> isdir(b.base)
723
1091
    True
724
1092
    >>> bd = b.base
725
 
    >>> del b
 
1093
    >>> b.destroy()
726
1094
    >>> isdir(bd)
727
1095
    False
728
1096
    """
729
 
    def __init__(self, files = []):
 
1097
    def __init__(self, files=[], dirs=[], base=None):
730
1098
        """Make a test branch.
731
1099
 
732
1100
        This creates a temporary directory and runs init-tree in it.
733
1101
 
734
1102
        If any files are listed, they are created in the working copy.
735
1103
        """
736
 
        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)
 
1110
        for d in dirs:
 
1111
            os.mkdir(self.abspath(d))
 
1112
            
737
1113
        for f in files:
738
1114
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
739
1115
 
740
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
        
741
1133
    def __del__(self):
 
1134
        self.destroy()
 
1135
 
 
1136
    def destroy(self):
742
1137
        """Destroy the test branch, removing the scratch directory."""
743
 
        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
744
1152
 
745
1153
    
746
1154
 
756
1164
        ## mutter('check %r for control file' % ((head, tail), ))
757
1165
        if tail == bzrlib.BZRDIR:
758
1166
            return True
 
1167
        if filename == head:
 
1168
            break
759
1169
        filename = head
760
1170
    return False
761
1171
 
762
1172
 
763
1173
 
764
 
def _gen_revision_id(when):
765
 
    """Return new revision-id."""
766
 
    s = '%s-%s-' % (user_email(), compact_date(when))
767
 
    s += hexlify(rand_bytes(8))
768
 
    return s
769
 
 
770
 
 
771
 
def _gen_file_id(name):
 
1174
def gen_file_id(name):
772
1175
    """Return new file id.
773
1176
 
774
1177
    This should probably generate proper UUIDs, but for the moment we
775
1178
    cope with just randomness because running uuidgen every time is
776
1179
    slow."""
777
 
    assert '/' not in name
778
 
    while name[0] == '.':
779
 
        name = name[1:]
 
1180
    import re
 
1181
    from binascii import hexlify
 
1182
    from time import time
 
1183
 
 
1184
    # get last component
 
1185
    idx = name.rfind('/')
 
1186
    if idx != -1:
 
1187
        name = name[idx+1 : ]
 
1188
    idx = name.rfind('\\')
 
1189
    if idx != -1:
 
1190
        name = name[idx+1 : ]
 
1191
 
 
1192
    # make it not a hidden file
 
1193
    name = name.lstrip('.')
 
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
 
780
1199
    s = hexlify(rand_bytes(8))
781
 
    return '-'.join((name, compact_date(time.time()), s))
782
 
 
783
 
 
 
1200
    return '-'.join((name, compact_date(time()), s))