~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-24 00:44:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050324004418-b4a050f656c07f5f
show space usage for various stores in the info command

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
import sys
19
 
import os
 
18
from sets import Set
 
19
 
 
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
 
21
import traceback, socket, fnmatch, difflib, time
 
22
from binascii import hexlify
20
23
 
21
24
import bzrlib
22
 
from bzrlib.trace import mutter, note
23
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
 
     splitpath, \
25
 
     sha_file, appendpath, file_kind
26
 
 
27
 
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId, \
28
 
     DivergedBranches, NotBranchError
29
 
from bzrlib.textui import show_status
30
 
from bzrlib.revision import Revision
31
 
from bzrlib.delta import compare_trees
32
 
from bzrlib.tree import EmptyTree, RevisionTree
33
 
import bzrlib.xml
34
 
import bzrlib.ui
35
 
 
36
 
 
 
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
37
37
 
38
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
39
## TODO: Maybe include checks for common corruption of newlines, etc?
40
40
 
41
41
 
42
 
# TODO: Some operations like log might retrieve the same revisions
43
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
44
 
# cache in memory to make this faster.
45
 
 
46
 
def find_branch(*ignored, **ignored_too):
47
 
    # XXX: leave this here for about one release, then remove it
48
 
    raise NotImplementedError('find_branch() is not supported anymore, '
49
 
                              'please use one of the new branch constructors')
50
 
 
51
 
def _relpath(base, path):
52
 
    """Return path relative to base, or raise exception.
53
 
 
54
 
    The path may be either an absolute path or a path relative to the
55
 
    current working directory.
56
 
 
57
 
    Lifted out of Branch.relpath for ease of testing.
58
 
 
59
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
60
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
61
 
    avoids that problem."""
62
 
    rp = os.path.abspath(path)
63
 
 
64
 
    s = []
65
 
    head = rp
66
 
    while len(head) >= len(base):
67
 
        if head == base:
68
 
            break
69
 
        head, tail = os.path.split(head)
70
 
        if tail:
71
 
            s.insert(0, tail)
72
 
    else:
73
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
74
 
 
75
 
    return os.sep.join(s)
76
 
        
77
42
 
78
43
def find_branch_root(f=None):
79
44
    """Find the branch root enclosing f, or pwd.
80
45
 
81
 
    f may be a filename or a URL.
82
 
 
83
46
    It is not necessary that f exists.
84
47
 
85
48
    Basically we keep looking up until we find the control directory or
86
 
    run into the root.  If there isn't one, raises NotBranchError.
87
 
    """
88
 
    if f == None:
 
49
    run into the root."""
 
50
    if f is None:
89
51
        f = os.getcwd()
90
52
    elif hasattr(os.path, 'realpath'):
91
53
        f = os.path.realpath(f)
92
54
    else:
93
55
        f = os.path.abspath(f)
94
 
    if not os.path.exists(f):
95
 
        raise BzrError('%r does not exist' % f)
96
 
        
97
56
 
98
57
    orig_f = f
99
58
 
 
59
    last_f = f
100
60
    while True:
101
61
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
102
62
            return f
103
63
        head, tail = os.path.split(f)
104
64
        if head == f:
105
65
            # reached the root, whatever that may be
106
 
            raise NotBranchError('%s is not in a branch' % orig_f)
 
66
            bailout('%r is not in a branch' % orig_f)
107
67
        f = head
108
 
 
109
 
 
 
68
    
110
69
 
111
70
 
112
71
######################################################################
113
72
# branch objects
114
73
 
115
 
class Branch(object):
 
74
class Branch:
116
75
    """Branch holding a history of revisions.
117
76
 
118
 
    base
119
 
        Base directory/url of the branch.
120
 
    """
121
 
    base = None
122
 
 
123
 
    def __init__(self, *ignored, **ignored_too):
124
 
        raise NotImplementedError('The Branch class is abstract')
125
 
 
126
 
    @staticmethod
127
 
    def open(base):
128
 
        """Open an existing branch, rooted at 'base' (url)"""
129
 
        if base and (base.startswith('http://') or base.startswith('https://')):
130
 
            from bzrlib.remotebranch import RemoteBranch
131
 
            return RemoteBranch(base, find_root=False)
132
 
        else:
133
 
            return LocalBranch(base, find_root=False)
134
 
 
135
 
    @staticmethod
136
 
    def open_containing(url):
137
 
        """Open an existing branch, containing url (search upwards for the root)
138
 
        """
139
 
        if url and (url.startswith('http://') or url.startswith('https://')):
140
 
            from bzrlib.remotebranch import RemoteBranch
141
 
            return RemoteBranch(url)
142
 
        else:
143
 
            return LocalBranch(url)
144
 
 
145
 
    @staticmethod
146
 
    def initialize(base):
147
 
        """Create a new branch, rooted at 'base' (url)"""
148
 
        if base and (base.startswith('http://') or base.startswith('https://')):
149
 
            from bzrlib.remotebranch import RemoteBranch
150
 
            return RemoteBranch(base, init=True)
151
 
        else:
152
 
            return LocalBranch(base, init=True)
153
 
 
154
 
    def setup_caching(self, cache_root):
155
 
        """Subclasses that care about caching should override this, and set
156
 
        up cached stores located under cache_root.
157
 
        """
158
 
 
159
 
 
160
 
class LocalBranch(Branch):
161
 
    """A branch stored in the actual filesystem.
162
 
 
163
 
    Note that it's "local" in the context of the filesystem; it doesn't
164
 
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
165
 
    it's writable, and can be accessed via the normal filesystem API.
166
 
 
167
 
    _lock_mode
168
 
        None, or 'r' or 'w'
169
 
 
170
 
    _lock_count
171
 
        If _lock_mode is true, a positive count of the number of times the
172
 
        lock has been taken.
173
 
 
174
 
    _lock
175
 
        Lock object from bzrlib.lock.
176
 
    """
177
 
    # We actually expect this class to be somewhat short-lived; part of its
178
 
    # purpose is to try to isolate what bits of the branch logic are tied to
179
 
    # filesystem access, so that in a later step, we can extricate them to
180
 
    # a separarte ("storage") class.
181
 
    _lock_mode = None
182
 
    _lock_count = None
183
 
    _lock = None
184
 
 
 
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.
 
89
    """
185
90
    def __init__(self, base, init=False, find_root=True):
186
91
        """Create new branch object at a particular location.
187
92
 
188
 
        base -- Base directory for the branch. May be a file:// url.
 
93
        :param base: Base directory for the branch.
189
94
        
190
 
        init -- If True, create new control files in a previously
 
95
        :param init: If True, create new control files in a previously
191
96
             unversioned directory.  If False, the branch must already
192
97
             be versioned.
193
98
 
194
 
        find_root -- If true and init is false, find the root of the
 
99
        :param find_root: If true and init is false, find the root of the
195
100
             existing branch containing base.
196
101
 
197
102
        In the test suite, creation of new trees is tested using the
198
103
        `ScratchBranch` class.
199
104
        """
200
 
        from bzrlib.store import ImmutableStore
201
105
        if init:
202
106
            self.base = os.path.realpath(base)
203
107
            self._make_control()
204
108
        elif find_root:
205
109
            self.base = find_branch_root(base)
206
110
        else:
207
 
            if base.startswith("file://"):
208
 
                base = base[7:]
209
111
            self.base = os.path.realpath(base)
210
112
            if not isdir(self.controlfilename('.')):
211
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
212
 
                                     ['use "bzr init" to initialize a new working tree',
213
 
                                      'current bzr can only operate from top-of-tree'])
 
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'])
214
116
        self._check_format()
215
117
 
216
118
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
225
127
    __repr__ = __str__
226
128
 
227
129
 
228
 
    def __del__(self):
229
 
        if self._lock_mode or self._lock:
230
 
            from bzrlib.warnings import warn
231
 
            warn("branch %r was not explicitly unlocked" % self)
232
 
            self._lock.unlock()
233
 
 
234
 
    def lock_write(self):
235
 
        if self._lock_mode:
236
 
            if self._lock_mode != 'w':
237
 
                from bzrlib.errors import LockError
238
 
                raise LockError("can't upgrade to a write lock from %r" %
239
 
                                self._lock_mode)
240
 
            self._lock_count += 1
241
 
        else:
242
 
            from bzrlib.lock import WriteLock
243
 
 
244
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
245
 
            self._lock_mode = 'w'
246
 
            self._lock_count = 1
247
 
 
248
 
 
249
 
    def lock_read(self):
250
 
        if self._lock_mode:
251
 
            assert self._lock_mode in ('r', 'w'), \
252
 
                   "invalid lock mode %r" % self._lock_mode
253
 
            self._lock_count += 1
254
 
        else:
255
 
            from bzrlib.lock import ReadLock
256
 
 
257
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
258
 
            self._lock_mode = 'r'
259
 
            self._lock_count = 1
260
 
                        
261
 
    def unlock(self):
262
 
        if not self._lock_mode:
263
 
            from bzrlib.errors import LockError
264
 
            raise LockError('branch %r is not locked' % (self))
265
 
 
266
 
        if self._lock_count > 1:
267
 
            self._lock_count -= 1
268
 
        else:
269
 
            self._lock.unlock()
270
 
            self._lock = None
271
 
            self._lock_mode = self._lock_count = None
272
 
 
273
130
    def abspath(self, name):
274
131
        """Return absolute filename for something in the branch"""
275
132
        return os.path.join(self.base, name)
276
133
 
 
134
 
277
135
    def relpath(self, path):
278
136
        """Return path relative to this branch of something inside it.
279
137
 
280
138
        Raises an error if path is not in this branch."""
281
 
        return _relpath(self.base, path)
 
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
 
146
 
282
147
 
283
148
    def controlfilename(self, file_or_path):
284
149
        """Return location relative to branch."""
285
 
        if isinstance(file_or_path, basestring):
 
150
        if isinstance(file_or_path, types.StringTypes):
286
151
            file_or_path = [file_or_path]
287
152
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
288
153
 
289
154
 
290
155
    def controlfile(self, file_or_path, mode='r'):
291
 
        """Open a control file for this branch.
292
 
 
293
 
        There are two classes of file in the control directory: text
294
 
        and binary.  binary files are untranslated byte streams.  Text
295
 
        control files are stored with Unix newlines and in UTF-8, even
296
 
        if the platform or locale defaults are different.
297
 
 
298
 
        Controlfiles should almost never be opened in write mode but
299
 
        rather should be atomically copied and replaced using atomicfile.
300
 
        """
301
 
 
302
 
        fn = self.controlfilename(file_or_path)
303
 
 
304
 
        if mode == 'rb' or mode == 'wb':
305
 
            return file(fn, mode)
306
 
        elif mode == 'r' or mode == 'w':
307
 
            # open in binary mode anyhow so there's no newline translation;
308
 
            # codecs uses line buffering by default; don't want that.
309
 
            import codecs
310
 
            return codecs.open(fn, mode + 'b', 'utf-8',
311
 
                               buffering=60000)
312
 
        else:
313
 
            raise BzrError("invalid controlfile mode %r" % mode)
 
156
        """Open a control file for this branch"""
 
157
        return file(self.controlfilename(file_or_path), mode)
 
158
 
314
159
 
315
160
    def _make_control(self):
316
 
        from bzrlib.inventory import Inventory
317
 
        
318
161
        os.mkdir(self.controlfilename([]))
319
162
        self.controlfile('README', 'w').write(
320
163
            "This is a Bazaar-NG control directory.\n"
321
 
            "Do not change any files in this directory.\n")
 
164
            "Do not change any files in this directory.")
322
165
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
323
166
        for d in ('text-store', 'inventory-store', 'revision-store'):
324
167
            os.mkdir(self.controlfilename(d))
325
168
        for f in ('revision-history', 'merged-patches',
326
 
                  'pending-merged-patches', 'branch-name',
327
 
                  'branch-lock',
328
 
                  'pending-merges'):
 
169
                  'pending-merged-patches', 'branch-name'):
329
170
            self.controlfile(f, 'w').write('')
330
171
        mutter('created control directory in ' + self.base)
331
 
 
332
 
        # if we want per-tree root ids then this is the place to set
333
 
        # them; they're not needed for now and so ommitted for
334
 
        # simplicity.
335
 
        f = self.controlfile('inventory','w')
336
 
        bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
 
172
        Inventory().write_xml(self.controlfile('inventory','w'))
337
173
 
338
174
 
339
175
    def _check_format(self):
343
179
 
344
180
        In the future, we might need different in-memory Branch
345
181
        classes to support downlevel branches.  But not yet.
346
 
        """
347
 
        # This ignores newlines so that we can open branches created
348
 
        # on Windows from Linux and so on.  I think it might be better
349
 
        # to always make all internal files in unix format.
350
 
        fmt = self.controlfile('branch-format', 'r').read()
351
 
        fmt = fmt.replace('\r\n', '\n')
 
182
        """        
 
183
        # read in binary mode to detect newline wierdness.
 
184
        fmt = self.controlfile('branch-format', 'rb').read()
352
185
        if fmt != BZR_BRANCH_FORMAT:
353
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
354
 
                           ['use a different bzr version',
355
 
                            'or remove the .bzr directory and "bzr init" again'])
356
 
 
357
 
    def get_root_id(self):
358
 
        """Return the id of this branches root"""
359
 
        inv = self.read_working_inventory()
360
 
        return inv.root.file_id
361
 
 
362
 
    def set_root_id(self, file_id):
363
 
        inv = self.read_working_inventory()
364
 
        orig_root_id = inv.root.file_id
365
 
        del inv._byid[inv.root.file_id]
366
 
        inv.root.file_id = file_id
367
 
        inv._byid[inv.root.file_id] = inv.root
368
 
        for fid in inv:
369
 
            entry = inv[fid]
370
 
            if entry.parent_id in (None, orig_root_id):
371
 
                entry.parent_id = inv.root.file_id
372
 
        self._write_inventory(inv)
 
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'])
 
189
 
373
190
 
374
191
    def read_working_inventory(self):
375
192
        """Read the working inventory."""
376
 
        from bzrlib.inventory import Inventory
377
 
        self.lock_read()
378
 
        try:
379
 
            # ElementTree does its own conversion from UTF-8, so open in
380
 
            # binary.
381
 
            f = self.controlfile('inventory', 'rb')
382
 
            return bzrlib.xml.serializer_v4.read_inventory(f)
383
 
        finally:
384
 
            self.unlock()
385
 
            
 
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
 
386
199
 
387
200
    def _write_inventory(self, inv):
388
201
        """Update the working inventory.
390
203
        That is to say, the inventory describing changes underway, that
391
204
        will be committed to the next revision.
392
205
        """
393
 
        from bzrlib.atomicfile import AtomicFile
394
 
        
395
 
        self.lock_write()
396
 
        try:
397
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
398
 
            try:
399
 
                bzrlib.xml.serializer_v4.write_inventory(inv, f)
400
 
                f.commit()
401
 
            finally:
402
 
                f.close()
403
 
        finally:
404
 
            self.unlock()
405
 
        
 
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'))
406
213
        mutter('wrote working inventory')
407
 
            
 
214
 
408
215
 
409
216
    inventory = property(read_working_inventory, _write_inventory, None,
410
217
                         """Inventory for the working copy.""")
411
218
 
412
219
 
413
 
    def add(self, files, ids=None):
 
220
    def add(self, files, verbose=False):
414
221
        """Make files versioned.
415
222
 
416
 
        Note that the command line normally calls smart_add instead,
417
 
        which can automatically recurse.
418
 
 
419
223
        This puts the files in the Added state, so that they will be
420
224
        recorded by the next commit.
421
225
 
422
 
        files
423
 
            List of paths to add, relative to the base of the tree.
424
 
 
425
 
        ids
426
 
            If set, use these instead of automatically generated ids.
427
 
            Must be the same length as the list of files, but may
428
 
            contain None for ids that are to be autogenerated.
429
 
 
430
 
        TODO: Perhaps have an option to add the ids even if the files do
431
 
              not (yet) exist.
432
 
 
433
 
        TODO: Perhaps yield the ids and paths as they're added.
 
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', [])
434
259
        """
 
260
 
435
261
        # TODO: Re-adding a file that is removed in the working copy
436
262
        # should probably put it back with the previous ID.
437
 
        if isinstance(files, basestring):
438
 
            assert(ids is None or isinstance(ids, basestring))
 
263
        if isinstance(files, types.StringTypes):
439
264
            files = [files]
440
 
            if ids is not None:
441
 
                ids = [ids]
442
 
 
443
 
        if ids is None:
444
 
            ids = [None] * len(files)
445
 
        else:
446
 
            assert(len(ids) == len(files))
447
 
 
448
 
        self.lock_write()
449
 
        try:
450
 
            inv = self.read_working_inventory()
451
 
            for f,file_id in zip(files, ids):
452
 
                if is_control_file(f):
453
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
454
 
 
455
 
                fp = splitpath(f)
456
 
 
457
 
                if len(fp) == 0:
458
 
                    raise BzrError("cannot add top-level %r" % f)
459
 
 
460
 
                fullpath = os.path.normpath(self.abspath(f))
461
 
 
462
 
                try:
463
 
                    kind = file_kind(fullpath)
464
 
                except OSError:
465
 
                    # maybe something better?
466
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
467
 
 
468
 
                if kind != 'file' and kind != 'directory':
469
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
470
 
 
471
 
                if file_id is None:
472
 
                    file_id = gen_file_id(f)
473
 
                inv.add_path(f, kind=kind, file_id=file_id)
474
 
 
475
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
476
 
 
477
 
            self._write_inventory(inv)
478
 
        finally:
479
 
            self.unlock()
480
 
            
481
 
 
482
 
    def print_file(self, file, revno):
483
 
        """Print `file` to stdout."""
484
 
        self.lock_read()
485
 
        try:
486
 
            tree = self.revision_tree(self.get_rev_id(revno))
487
 
            # use inventory as it was in that revision
488
 
            file_id = tree.inventory.path2id(file)
489
 
            if not file_id:
490
 
                raise BzrError("%r is not present in revision %s" % (file, revno))
491
 
            tree.print_file(file_id)
492
 
        finally:
493
 
            self.unlock()
 
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
 
494
297
 
495
298
 
496
299
    def remove(self, files, verbose=False):
498
301
 
499
302
        This does not remove their text.  This does not run on 
500
303
 
501
 
        TODO: Refuse to remove modified files unless --force is given?
502
 
 
503
 
        TODO: Do something useful with directories.
504
 
 
505
 
        TODO: Should this remove the text or not?  Tough call; not
 
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
506
331
        removing may be useful and the user can just use use rm, and
507
332
        is the opposite of add.  Removing it is consistent with most
508
333
        other tools.  Maybe an option.
509
334
        """
510
335
        ## TODO: Normalize names
511
336
        ## TODO: Remove nested loops; better scalability
512
 
        if isinstance(files, basestring):
 
337
 
 
338
        if isinstance(files, types.StringTypes):
513
339
            files = [files]
514
 
 
515
 
        self.lock_write()
516
 
 
517
 
        try:
518
 
            tree = self.working_tree()
519
 
            inv = tree.inventory
520
 
 
521
 
            # do this before any modifications
522
 
            for f in files:
523
 
                fid = inv.path2id(f)
524
 
                if not fid:
525
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
526
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
527
 
                if verbose:
528
 
                    # having remove it, it must be either ignored or unknown
529
 
                    if tree.is_ignored(f):
530
 
                        new_status = 'I'
531
 
                    else:
532
 
                        new_status = '?'
533
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
534
 
                del inv[fid]
535
 
 
536
 
            self._write_inventory(inv)
537
 
        finally:
538
 
            self.unlock()
539
 
 
540
 
 
541
 
    # FIXME: this doesn't need to be a branch method
542
 
    def set_inventory(self, new_inventory_list):
543
 
        from bzrlib.inventory import Inventory, InventoryEntry
544
 
        inv = Inventory(self.get_root_id())
545
 
        for path, file_id, parent, kind in new_inventory_list:
546
 
            name = os.path.basename(path)
547
 
            if name == "":
548
 
                continue
549
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
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
 
550
359
        self._write_inventory(inv)
551
360
 
552
361
 
569
378
        return self.working_tree().unknowns()
570
379
 
571
380
 
572
 
    def append_revision(self, *revision_ids):
573
 
        from bzrlib.atomicfile import AtomicFile
574
 
 
575
 
        for revision_id in revision_ids:
576
 
            mutter("add {%s} to revision-history" % revision_id)
577
 
 
578
 
        rev_history = self.revision_history()
579
 
        rev_history.extend(revision_ids)
580
 
 
581
 
        f = AtomicFile(self.controlfilename('revision-history'))
582
 
        try:
583
 
            for rev_id in rev_history:
584
 
                print >>f, rev_id
585
 
            f.commit()
586
 
        finally:
587
 
            f.close()
588
 
 
589
 
 
590
 
    def get_revision_xml_file(self, revision_id):
591
 
        """Return XML file object for revision object."""
592
 
        if not revision_id or not isinstance(revision_id, basestring):
593
 
            raise InvalidRevisionId(revision_id)
594
 
 
595
 
        self.lock_read()
596
 
        try:
597
 
            try:
598
 
                return self.revision_store[revision_id]
599
 
            except (IndexError, KeyError):
600
 
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
601
 
        finally:
602
 
            self.unlock()
603
 
 
604
 
 
605
 
    #deprecated
606
 
    get_revision_xml = get_revision_xml_file
 
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 = 'R'
 
484
                        else:
 
485
                            state = 'M'
 
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
        self.controlfile('revision-history', 'at').write(rev_id + '\n')
 
546
 
 
547
        mutter("done!")
607
548
 
608
549
 
609
550
    def get_revision(self, revision_id):
610
551
        """Return the Revision object for a named revision"""
611
 
        xml_file = self.get_revision_xml_file(revision_id)
612
 
 
613
 
        try:
614
 
            r = bzrlib.xml.serializer_v4.read_revision(xml_file)
615
 
        except SyntaxError, e:
616
 
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
617
 
                                         [revision_id,
618
 
                                          str(e)])
619
 
            
 
552
        r = Revision.read_xml(self.revision_store[revision_id])
620
553
        assert r.revision_id == revision_id
621
554
        return r
622
555
 
623
556
 
624
 
    def get_revision_delta(self, revno):
625
 
        """Return the delta for one revision.
626
 
 
627
 
        The delta is relative to its mainline predecessor, or the
628
 
        empty tree for revision 1.
629
 
        """
630
 
        assert isinstance(revno, int)
631
 
        rh = self.revision_history()
632
 
        if not (1 <= revno <= len(rh)):
633
 
            raise InvalidRevisionNumber(revno)
634
 
 
635
 
        # revno is 1-based; list is 0-based
636
 
 
637
 
        new_tree = self.revision_tree(rh[revno-1])
638
 
        if revno == 1:
639
 
            old_tree = EmptyTree()
640
 
        else:
641
 
            old_tree = self.revision_tree(rh[revno-2])
642
 
 
643
 
        return compare_trees(old_tree, new_tree)
644
 
 
645
 
        
646
 
 
647
 
    def get_revision_sha1(self, revision_id):
648
 
        """Hash the stored value of a revision, and return it."""
649
 
        # In the future, revision entries will be signed. At that
650
 
        # point, it is probably best *not* to include the signature
651
 
        # in the revision hash. Because that lets you re-sign
652
 
        # the revision, (add signatures/remove signatures) and still
653
 
        # have all hash pointers stay consistent.
654
 
        # But for now, just hash the contents.
655
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
656
 
 
657
 
 
658
557
    def get_inventory(self, inventory_id):
659
558
        """Get Inventory object by hash.
660
559
 
661
 
        TODO: Perhaps for this and similar methods, take a revision
 
560
        :todo: Perhaps for this and similar methods, take a revision
662
561
               parameter which can be either an integer revno or a
663
562
               string hash."""
664
 
        from bzrlib.inventory import Inventory
665
 
 
666
 
        f = self.get_inventory_xml_file(inventory_id)
667
 
        return bzrlib.xml.serializer_v4.read_inventory(f)
668
 
 
669
 
 
670
 
    def get_inventory_xml(self, inventory_id):
671
 
        """Get inventory XML as a file object."""
672
 
        return self.inventory_store[inventory_id]
673
 
 
674
 
    get_inventory_xml_file = get_inventory_xml
675
 
            
676
 
 
677
 
    def get_inventory_sha1(self, inventory_id):
678
 
        """Return the sha1 hash of the inventory entry
679
 
        """
680
 
        return sha_file(self.get_inventory_xml(inventory_id))
 
563
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
564
        return i
681
565
 
682
566
 
683
567
    def get_revision_inventory(self, revision_id):
684
568
        """Return inventory of a past revision."""
685
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
686
 
        # must be the same as its revision, so this is trivial.
687
569
        if revision_id == None:
688
 
            from bzrlib.inventory import Inventory
689
 
            return Inventory(self.get_root_id())
 
570
            return Inventory()
690
571
        else:
691
 
            return self.get_inventory(revision_id)
 
572
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
692
573
 
693
574
 
694
575
    def revision_history(self):
697
578
        >>> ScratchBranch().revision_history()
698
579
        []
699
580
        """
700
 
        self.lock_read()
701
 
        try:
702
 
            return [l.rstrip('\r\n') for l in
703
 
                    self.controlfile('revision-history', 'r').readlines()]
704
 
        finally:
705
 
            self.unlock()
706
 
 
707
 
 
708
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
709
 
        """
710
 
        >>> from bzrlib.commit import commit
711
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
712
 
        >>> sb.common_ancestor(sb) == (None, None)
713
 
        True
714
 
        >>> commit(sb, "Committing first revision", verbose=False)
715
 
        >>> sb.common_ancestor(sb)[0]
716
 
        1
717
 
        >>> clone = sb.clone()
718
 
        >>> commit(sb, "Committing second revision", verbose=False)
719
 
        >>> sb.common_ancestor(sb)[0]
720
 
        2
721
 
        >>> sb.common_ancestor(clone)[0]
722
 
        1
723
 
        >>> commit(clone, "Committing divergent second revision", 
724
 
        ...               verbose=False)
725
 
        >>> sb.common_ancestor(clone)[0]
726
 
        1
727
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
728
 
        True
729
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
730
 
        True
731
 
        >>> clone2 = sb.clone()
732
 
        >>> sb.common_ancestor(clone2)[0]
733
 
        2
734
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
735
 
        1
736
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
737
 
        1
738
 
        """
739
 
        my_history = self.revision_history()
740
 
        other_history = other.revision_history()
741
 
        if self_revno is None:
742
 
            self_revno = len(my_history)
743
 
        if other_revno is None:
744
 
            other_revno = len(other_history)
745
 
        indices = range(min((self_revno, other_revno)))
746
 
        indices.reverse()
747
 
        for r in indices:
748
 
            if my_history[r] == other_history[r]:
749
 
                return r+1, my_history[r]
750
 
        return None, None
 
581
        return [chomp(l) for l in self.controlfile('revision-history').readlines()]
751
582
 
752
583
 
753
584
    def revno(self):
755
586
 
756
587
        That is equivalent to the number of revisions committed to
757
588
        this branch.
 
589
 
 
590
        >>> b = ScratchBranch()
 
591
        >>> b.revno()
 
592
        0
 
593
        >>> b.commit('no foo')
 
594
        >>> b.revno()
 
595
        1
758
596
        """
759
597
        return len(self.revision_history())
760
598
 
761
599
 
762
600
    def last_patch(self):
763
601
        """Return last patch hash, or None if no history.
 
602
 
 
603
        >>> ScratchBranch().last_patch() == None
 
604
        True
764
605
        """
765
606
        ph = self.revision_history()
766
607
        if ph:
767
608
            return ph[-1]
768
 
        else:
769
 
            return None
770
 
 
771
 
 
772
 
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
773
 
        """
774
 
        If self and other have not diverged, return a list of the revisions
775
 
        present in other, but missing from self.
776
 
 
777
 
        >>> from bzrlib.commit import commit
778
 
        >>> bzrlib.trace.silent = True
779
 
        >>> br1 = ScratchBranch()
780
 
        >>> br2 = ScratchBranch()
781
 
        >>> br1.missing_revisions(br2)
782
 
        []
783
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
784
 
        >>> br1.missing_revisions(br2)
785
 
        [u'REVISION-ID-1']
786
 
        >>> br2.missing_revisions(br1)
787
 
        []
788
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
789
 
        >>> br1.missing_revisions(br2)
790
 
        []
791
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
792
 
        >>> br1.missing_revisions(br2)
793
 
        [u'REVISION-ID-2A']
794
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
795
 
        >>> br1.missing_revisions(br2)
796
 
        Traceback (most recent call last):
797
 
        DivergedBranches: These branches have diverged.
798
 
        """
799
 
        self_history = self.revision_history()
800
 
        self_len = len(self_history)
801
 
        other_history = other.revision_history()
802
 
        other_len = len(other_history)
803
 
        common_index = min(self_len, other_len) -1
804
 
        if common_index >= 0 and \
805
 
            self_history[common_index] != other_history[common_index]:
806
 
            raise DivergedBranches(self, other)
807
 
 
808
 
        if stop_revision is None:
809
 
            stop_revision = other_len
810
 
        elif stop_revision > other_len:
811
 
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
812
 
        
813
 
        return other_history[self_len:stop_revision]
814
 
 
815
 
 
816
 
    def update_revisions(self, other, stop_revision=None):
817
 
        """Pull in all new revisions from other branch.
818
 
        """
819
 
        from bzrlib.fetch import greedy_fetch
820
 
        from bzrlib.revision import get_intervening_revisions
821
 
 
822
 
        pb = bzrlib.ui.ui_factory.progress_bar()
823
 
        pb.update('comparing histories')
824
 
        if stop_revision is None:
825
 
            other_revision = other.last_patch()
826
 
        else:
827
 
            other_revision = other.get_rev_id(stop_revision)
828
 
        count = greedy_fetch(self, other, other_revision, pb)[0]
829
 
        try:
830
 
            revision_ids = self.missing_revisions(other, stop_revision)
831
 
        except DivergedBranches, e:
832
 
            try:
833
 
                revision_ids = get_intervening_revisions(self.last_patch(), 
834
 
                                                         other_revision, self)
835
 
                assert self.last_patch() not in revision_ids
836
 
            except bzrlib.errors.NotAncestor:
837
 
                raise e
838
 
 
839
 
        self.append_revision(*revision_ids)
840
 
        pb.clear()
841
 
 
842
 
    def install_revisions(self, other, revision_ids, pb):
843
 
        if hasattr(other.revision_store, "prefetch"):
844
 
            other.revision_store.prefetch(revision_ids)
845
 
        if hasattr(other.inventory_store, "prefetch"):
846
 
            inventory_ids = []
847
 
            for rev_id in revision_ids:
848
 
                try:
849
 
                    revision = other.get_revision(rev_id).inventory_id
850
 
                    inventory_ids.append(revision)
851
 
                except bzrlib.errors.NoSuchRevision:
852
 
                    pass
853
 
            other.inventory_store.prefetch(inventory_ids)
854
 
 
855
 
        if pb is None:
856
 
            pb = bzrlib.ui.ui_factory.progress_bar()
857
 
                
858
 
        revisions = []
859
 
        needed_texts = set()
860
 
        i = 0
861
 
 
862
 
        failures = set()
863
 
        for i, rev_id in enumerate(revision_ids):
864
 
            pb.update('fetching revision', i+1, len(revision_ids))
865
 
            try:
866
 
                rev = other.get_revision(rev_id)
867
 
            except bzrlib.errors.NoSuchRevision:
868
 
                failures.add(rev_id)
869
 
                continue
870
 
 
871
 
            revisions.append(rev)
872
 
            inv = other.get_inventory(str(rev.inventory_id))
873
 
            for key, entry in inv.iter_entries():
874
 
                if entry.text_id is None:
875
 
                    continue
876
 
                if entry.text_id not in self.text_store:
877
 
                    needed_texts.add(entry.text_id)
878
 
 
879
 
        pb.clear()
880
 
                    
881
 
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
882
 
                                                    needed_texts)
883
 
        #print "Added %d texts." % count 
884
 
        inventory_ids = [ f.inventory_id for f in revisions ]
885
 
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
886
 
                                                         inventory_ids)
887
 
        #print "Added %d inventories." % count 
888
 
        revision_ids = [ f.revision_id for f in revisions]
889
 
 
890
 
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
891
 
                                                          revision_ids,
892
 
                                                          permit_failure=True)
893
 
        assert len(cp_fail) == 0 
894
 
        return count, failures
895
 
       
896
 
 
897
 
    def commit(self, *args, **kw):
898
 
        from bzrlib.commit import commit
899
 
        commit(self, *args, **kw)
900
 
        
901
 
    def revision_id_to_revno(self, revision_id):
902
 
        """Given a revision id, return its revno"""
903
 
        history = self.revision_history()
904
 
        try:
905
 
            return history.index(revision_id) + 1
906
 
        except ValueError:
907
 
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
908
 
 
909
 
    def get_rev_id(self, revno, history=None):
910
 
        """Find the revision id of the specified revno."""
 
609
 
 
610
 
 
611
    def lookup_revision(self, revno):
 
612
        """Return revision hash for revision number."""
911
613
        if revno == 0:
912
614
            return None
913
 
        if history is None:
914
 
            history = self.revision_history()
915
 
        elif revno <= 0 or revno > len(history):
916
 
            raise bzrlib.errors.NoSuchRevision(self, revno)
917
 
        return history[revno - 1]
 
615
 
 
616
        try:
 
617
            # list is 0-based; revisions are 1-based
 
618
            return self.revision_history()[revno-1]
 
619
        except IndexError:
 
620
            bailout("no such revision %s" % revno)
918
621
 
919
622
 
920
623
    def revision_tree(self, revision_id):
922
625
 
923
626
        `revision_id` may be None for the null revision, in which case
924
627
        an `EmptyTree` is returned."""
925
 
        # TODO: refactor this to use an existing revision object
926
 
        # so we don't need to read it in twice.
 
628
 
927
629
        if revision_id == None:
928
630
            return EmptyTree()
929
631
        else:
933
635
 
934
636
    def working_tree(self):
935
637
        """Return a `Tree` for the working copy."""
936
 
        from bzrlib.workingtree import WorkingTree
937
638
        return WorkingTree(self.base, self.read_working_inventory())
938
639
 
939
640
 
941
642
        """Return `Tree` object for last revision.
942
643
 
943
644
        If there are no revisions yet, return an `EmptyTree`.
 
645
 
 
646
        >>> b = ScratchBranch(files=['foo'])
 
647
        >>> b.basis_tree().has_filename('foo')
 
648
        False
 
649
        >>> b.working_tree().has_filename('foo')
 
650
        True
 
651
        >>> b.add('foo')
 
652
        >>> b.commit('add foo')
 
653
        >>> b.basis_tree().has_filename('foo')
 
654
        True
944
655
        """
945
656
        r = self.last_patch()
946
657
        if r == None:
950
661
 
951
662
 
952
663
 
953
 
    def rename_one(self, from_rel, to_rel):
954
 
        """Rename one file.
955
 
 
956
 
        This can change the directory or the filename or both.
957
 
        """
958
 
        self.lock_write()
959
 
        try:
960
 
            tree = self.working_tree()
961
 
            inv = tree.inventory
962
 
            if not tree.has_filename(from_rel):
963
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
964
 
            if tree.has_filename(to_rel):
965
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
966
 
 
967
 
            file_id = inv.path2id(from_rel)
968
 
            if file_id == None:
969
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
970
 
 
971
 
            if inv.path2id(to_rel):
972
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
973
 
 
974
 
            to_dir, to_tail = os.path.split(to_rel)
975
 
            to_dir_id = inv.path2id(to_dir)
976
 
            if to_dir_id == None and to_dir != '':
977
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
978
 
 
979
 
            mutter("rename_one:")
980
 
            mutter("  file_id    {%s}" % file_id)
981
 
            mutter("  from_rel   %r" % from_rel)
982
 
            mutter("  to_rel     %r" % to_rel)
983
 
            mutter("  to_dir     %r" % to_dir)
984
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
985
 
 
986
 
            inv.rename(file_id, to_dir_id, to_tail)
987
 
 
988
 
            from_abs = self.abspath(from_rel)
989
 
            to_abs = self.abspath(to_rel)
990
 
            try:
991
 
                os.rename(from_abs, to_abs)
992
 
            except OSError, e:
993
 
                raise BzrError("failed to rename %r to %r: %s"
994
 
                        % (from_abs, to_abs, e[1]),
995
 
                        ["rename rolled back"])
996
 
 
997
 
            self._write_inventory(inv)
998
 
        finally:
999
 
            self.unlock()
1000
 
 
1001
 
 
1002
 
    def move(self, from_paths, to_name):
1003
 
        """Rename files.
1004
 
 
1005
 
        to_name must exist as a versioned directory.
1006
 
 
1007
 
        If to_name exists and is a directory, the files are moved into
1008
 
        it, keeping their old names.  If it is a directory, 
1009
 
 
1010
 
        Note that to_name is only the last component of the new name;
1011
 
        this doesn't change the directory.
1012
 
 
1013
 
        This returns a list of (from_path, to_path) pairs for each
1014
 
        entry that is moved.
1015
 
        """
1016
 
        result = []
1017
 
        self.lock_write()
1018
 
        try:
1019
 
            ## TODO: Option to move IDs only
1020
 
            assert not isinstance(from_paths, basestring)
1021
 
            tree = self.working_tree()
1022
 
            inv = tree.inventory
1023
 
            to_abs = self.abspath(to_name)
1024
 
            if not isdir(to_abs):
1025
 
                raise BzrError("destination %r is not a directory" % to_abs)
1026
 
            if not tree.has_filename(to_name):
1027
 
                raise BzrError("destination %r not in working directory" % to_abs)
1028
 
            to_dir_id = inv.path2id(to_name)
1029
 
            if to_dir_id == None and to_name != '':
1030
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
1031
 
            to_dir_ie = inv[to_dir_id]
1032
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
1033
 
                raise BzrError("destination %r is not a directory" % to_abs)
1034
 
 
1035
 
            to_idpath = inv.get_idpath(to_dir_id)
1036
 
 
1037
 
            for f in from_paths:
1038
 
                if not tree.has_filename(f):
1039
 
                    raise BzrError("%r does not exist in working tree" % f)
1040
 
                f_id = inv.path2id(f)
1041
 
                if f_id == None:
1042
 
                    raise BzrError("%r is not versioned" % f)
1043
 
                name_tail = splitpath(f)[-1]
1044
 
                dest_path = appendpath(to_name, name_tail)
1045
 
                if tree.has_filename(dest_path):
1046
 
                    raise BzrError("destination %r already exists" % dest_path)
1047
 
                if f_id in to_idpath:
1048
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
1049
 
 
1050
 
            # OK, so there's a race here, it's possible that someone will
1051
 
            # create a file in this interval and then the rename might be
1052
 
            # left half-done.  But we should have caught most problems.
1053
 
 
1054
 
            for f in from_paths:
1055
 
                name_tail = splitpath(f)[-1]
1056
 
                dest_path = appendpath(to_name, name_tail)
1057
 
                result.append((f, dest_path))
1058
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1059
 
                try:
1060
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
1061
 
                except OSError, e:
1062
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1063
 
                            ["rename rolled back"])
1064
 
 
1065
 
            self._write_inventory(inv)
1066
 
        finally:
1067
 
            self.unlock()
1068
 
 
1069
 
        return result
1070
 
 
1071
 
 
1072
 
    def revert(self, filenames, old_tree=None, backups=True):
1073
 
        """Restore selected files to the versions from a previous tree.
1074
 
 
1075
 
        backups
1076
 
            If true (default) backups are made of files before
1077
 
            they're renamed.
1078
 
        """
1079
 
        from bzrlib.errors import NotVersionedError, BzrError
1080
 
        from bzrlib.atomicfile import AtomicFile
1081
 
        from bzrlib.osutils import backup_file
1082
 
        
1083
 
        inv = self.read_working_inventory()
1084
 
        if old_tree is None:
1085
 
            old_tree = self.basis_tree()
1086
 
        old_inv = old_tree.inventory
1087
 
 
1088
 
        nids = []
1089
 
        for fn in filenames:
1090
 
            file_id = inv.path2id(fn)
1091
 
            if not file_id:
1092
 
                raise NotVersionedError("not a versioned file", fn)
1093
 
            if not old_inv.has_id(file_id):
1094
 
                raise BzrError("file not present in old tree", fn, file_id)
1095
 
            nids.append((fn, file_id))
1096
 
            
1097
 
        # TODO: Rename back if it was previously at a different location
1098
 
 
1099
 
        # TODO: If given a directory, restore the entire contents from
1100
 
        # the previous version.
1101
 
 
1102
 
        # TODO: Make a backup to a temporary file.
1103
 
 
1104
 
        # TODO: If the file previously didn't exist, delete it?
1105
 
        for fn, file_id in nids:
1106
 
            backup_file(fn)
1107
 
            
1108
 
            f = AtomicFile(fn, 'wb')
1109
 
            try:
1110
 
                f.write(old_tree.get_file(file_id).read())
1111
 
                f.commit()
1112
 
            finally:
1113
 
                f.close()
1114
 
 
1115
 
 
1116
 
    def pending_merges(self):
1117
 
        """Return a list of pending merges.
1118
 
 
1119
 
        These are revisions that have been merged into the working
1120
 
        directory but not yet committed.
1121
 
        """
1122
 
        cfn = self.controlfilename('pending-merges')
1123
 
        if not os.path.exists(cfn):
1124
 
            return []
1125
 
        p = []
1126
 
        for l in self.controlfile('pending-merges', 'r').readlines():
1127
 
            p.append(l.rstrip('\n'))
1128
 
        return p
1129
 
 
1130
 
 
1131
 
    def add_pending_merge(self, revision_id):
1132
 
        from bzrlib.revision import validate_revision_id
1133
 
 
1134
 
        validate_revision_id(revision_id)
1135
 
 
1136
 
        p = self.pending_merges()
1137
 
        if revision_id in p:
1138
 
            return
1139
 
        p.append(revision_id)
1140
 
        self.set_pending_merges(p)
1141
 
 
1142
 
 
1143
 
    def set_pending_merges(self, rev_list):
1144
 
        from bzrlib.atomicfile import AtomicFile
1145
 
        self.lock_write()
1146
 
        try:
1147
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1148
 
            try:
1149
 
                for l in rev_list:
1150
 
                    print >>f, l
1151
 
                f.commit()
1152
 
            finally:
1153
 
                f.close()
1154
 
        finally:
1155
 
            self.unlock()
1156
 
 
1157
 
 
1158
 
    def get_parent(self):
1159
 
        """Return the parent location of the branch.
1160
 
 
1161
 
        This is the default location for push/pull/missing.  The usual
1162
 
        pattern is that the user can override it by specifying a
1163
 
        location.
1164
 
        """
1165
 
        import errno
1166
 
        _locs = ['parent', 'pull', 'x-pull']
1167
 
        for l in _locs:
1168
 
            try:
1169
 
                return self.controlfile(l, 'r').read().strip('\n')
1170
 
            except IOError, e:
1171
 
                if e.errno != errno.ENOENT:
1172
 
                    raise
1173
 
        return None
1174
 
 
1175
 
 
1176
 
    def set_parent(self, url):
1177
 
        # TODO: Maybe delete old location files?
1178
 
        from bzrlib.atomicfile import AtomicFile
1179
 
        self.lock_write()
1180
 
        try:
1181
 
            f = AtomicFile(self.controlfilename('parent'))
1182
 
            try:
1183
 
                f.write(url + '\n')
1184
 
                f.commit()
1185
 
            finally:
1186
 
                f.close()
1187
 
        finally:
1188
 
            self.unlock()
1189
 
 
1190
 
    def check_revno(self, revno):
1191
 
        """\
1192
 
        Check whether a revno corresponds to any revision.
1193
 
        Zero (the NULL revision) is considered valid.
1194
 
        """
1195
 
        if revno != 0:
1196
 
            self.check_real_revno(revno)
1197
 
            
1198
 
    def check_real_revno(self, revno):
1199
 
        """\
1200
 
        Check whether a revno corresponds to a real revision.
1201
 
        Zero (the NULL revision) is considered invalid
1202
 
        """
1203
 
        if revno < 1 or revno > self.revno():
1204
 
            raise InvalidRevisionNumber(revno)
1205
 
        
1206
 
        
1207
 
        
1208
 
 
1209
 
 
1210
 
class ScratchBranch(LocalBranch):
 
664
    def write_log(self, show_timezone='original'):
 
665
        """Write out human-readable log of commits to this branch
 
666
 
 
667
        :param utc: If true, show dates in universal time, not local time."""
 
668
        ## TODO: Option to choose either original, utc or local timezone
 
669
        revno = 1
 
670
        precursor = None
 
671
        for p in self.revision_history():
 
672
            print '-' * 40
 
673
            print 'revno:', revno
 
674
            ## TODO: Show hash if --id is given.
 
675
            ##print 'revision-hash:', p
 
676
            rev = self.get_revision(p)
 
677
            print 'committer:', rev.committer
 
678
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
679
                                                 show_timezone))
 
680
 
 
681
            ## opportunistic consistency check, same as check_patch_chaining
 
682
            if rev.precursor != precursor:
 
683
                bailout("mismatched precursor!")
 
684
 
 
685
            print 'message:'
 
686
            if not rev.message:
 
687
                print '  (no message)'
 
688
            else:
 
689
                for l in rev.message.split('\n'):
 
690
                    print '  ' + l
 
691
 
 
692
            revno += 1
 
693
            precursor = p
 
694
 
 
695
 
 
696
 
 
697
    def show_status(branch, show_all=False):
 
698
        """Display single-line status for non-ignored working files.
 
699
 
 
700
        The list is show sorted in order by file name.
 
701
 
 
702
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
703
        >>> b.show_status()
 
704
        ?       foo
 
705
        >>> b.add('foo')
 
706
        >>> b.show_status()
 
707
        A       foo
 
708
        >>> b.commit("add foo")
 
709
        >>> b.show_status()
 
710
        >>> os.unlink(b.abspath('foo'))
 
711
        >>> b.show_status()
 
712
        D       foo
 
713
        
 
714
 
 
715
        :todo: Get state for single files.
 
716
 
 
717
        :todo: Perhaps show a slash at the end of directory names.        
 
718
 
 
719
        """
 
720
 
 
721
        # We have to build everything into a list first so that it can
 
722
        # sorted by name, incorporating all the different sources.
 
723
 
 
724
        # FIXME: Rather than getting things in random order and then sorting,
 
725
        # just step through in order.
 
726
 
 
727
        # Interesting case: the old ID for a file has been removed,
 
728
        # but a new file has been created under that name.
 
729
 
 
730
        old = branch.basis_tree()
 
731
        old_inv = old.inventory
 
732
        new = branch.working_tree()
 
733
        new_inv = new.inventory
 
734
 
 
735
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
 
736
            if fs == 'R':
 
737
                show_status(fs, kind,
 
738
                            oldname + ' => ' + newname)
 
739
            elif fs == 'A' or fs == 'M':
 
740
                show_status(fs, kind, newname)
 
741
            elif fs == 'D':
 
742
                show_status(fs, kind, oldname)
 
743
            elif fs == '.':
 
744
                if show_all:
 
745
                    show_status(fs, kind, newname)
 
746
            elif fs == 'I':
 
747
                if show_all:
 
748
                    show_status(fs, kind, newname)
 
749
            elif fs == '?':
 
750
                show_status(fs, kind, newname)
 
751
            else:
 
752
                bailout("wierd file state %r" % ((fs, fid),))
 
753
                
 
754
 
 
755
 
 
756
class ScratchBranch(Branch):
1211
757
    """Special test class: a branch that cleans up after itself.
1212
758
 
1213
759
    >>> b = ScratchBranch()
1214
760
    >>> isdir(b.base)
1215
761
    True
1216
762
    >>> bd = b.base
1217
 
    >>> b.destroy()
 
763
    >>> del b
1218
764
    >>> isdir(bd)
1219
765
    False
1220
766
    """
1221
 
    def __init__(self, files=[], dirs=[], base=None):
 
767
    def __init__(self, files = []):
1222
768
        """Make a test branch.
1223
769
 
1224
770
        This creates a temporary directory and runs init-tree in it.
1225
771
 
1226
772
        If any files are listed, they are created in the working copy.
1227
773
        """
1228
 
        from tempfile import mkdtemp
1229
 
        init = False
1230
 
        if base is None:
1231
 
            base = mkdtemp()
1232
 
            init = True
1233
 
        LocalBranch.__init__(self, base, init=init)
1234
 
        for d in dirs:
1235
 
            os.mkdir(self.abspath(d))
1236
 
            
 
774
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
1237
775
        for f in files:
1238
776
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1239
777
 
1240
778
 
1241
 
    def clone(self):
1242
 
        """
1243
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
1244
 
        >>> clone = orig.clone()
1245
 
        >>> os.path.samefile(orig.base, clone.base)
1246
 
        False
1247
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1248
 
        True
1249
 
        """
1250
 
        from shutil import copytree
1251
 
        from tempfile import mkdtemp
1252
 
        base = mkdtemp()
1253
 
        os.rmdir(base)
1254
 
        copytree(self.base, base, symlinks=True)
1255
 
        return ScratchBranch(base=base)
1256
 
 
1257
 
 
1258
 
        
1259
779
    def __del__(self):
1260
 
        self.destroy()
1261
 
 
1262
 
    def destroy(self):
1263
780
        """Destroy the test branch, removing the scratch directory."""
1264
 
        from shutil import rmtree
1265
 
        try:
1266
 
            if self.base:
1267
 
                mutter("delete ScratchBranch %s" % self.base)
1268
 
                rmtree(self.base)
1269
 
        except OSError, e:
1270
 
            # Work around for shutil.rmtree failing on Windows when
1271
 
            # readonly files are encountered
1272
 
            mutter("hit exception in destroying ScratchBranch: %s" % e)
1273
 
            for root, dirs, files in os.walk(self.base, topdown=False):
1274
 
                for name in files:
1275
 
                    os.chmod(os.path.join(root, name), 0700)
1276
 
            rmtree(self.base)
1277
 
        self.base = None
 
781
        shutil.rmtree(self.base)
1278
782
 
1279
783
    
1280
784
 
1297
801
 
1298
802
 
1299
803
 
 
804
def _gen_revision_id(when):
 
805
    """Return new revision-id."""
 
806
    s = '%s-%s-' % (user_email(), compact_date(when))
 
807
    s += hexlify(rand_bytes(8))
 
808
    return s
 
809
 
 
810
 
1300
811
def gen_file_id(name):
1301
812
    """Return new file id.
1302
813
 
1303
814
    This should probably generate proper UUIDs, but for the moment we
1304
815
    cope with just randomness because running uuidgen every time is
1305
816
    slow."""
1306
 
    import re
1307
 
    from binascii import hexlify
1308
 
    from time import time
1309
 
 
1310
 
    # get last component
1311
817
    idx = name.rfind('/')
1312
818
    if idx != -1:
1313
819
        name = name[idx+1 : ]
1314
 
    idx = name.rfind('\\')
1315
 
    if idx != -1:
1316
 
        name = name[idx+1 : ]
1317
820
 
1318
 
    # make it not a hidden file
1319
821
    name = name.lstrip('.')
1320
822
 
1321
 
    # remove any wierd characters; we don't escape them but rather
1322
 
    # just pull them out
1323
 
    name = re.sub(r'[^\w.]', '', name)
1324
 
 
1325
823
    s = hexlify(rand_bytes(8))
1326
 
    return '-'.join((name, compact_date(time()), s))
1327
 
 
1328
 
 
1329
 
def gen_root_id():
1330
 
    """Return a new tree-root file id."""
1331
 
    return gen_file_id('TREE_ROOT')
1332
 
 
1333
 
 
1334
 
def copy_branch(branch_from, to_location, revision=None):
1335
 
    """Copy branch_from into the existing directory to_location.
1336
 
 
1337
 
    revision
1338
 
        If not None, only revisions up to this point will be copied.
1339
 
        The head of the new branch will be that revision.
1340
 
 
1341
 
    to_location
1342
 
        The name of a local directory that exists but is empty.
1343
 
    """
1344
 
    from bzrlib.merge import merge
1345
 
    from bzrlib.revisionspec import RevisionSpec
1346
 
 
1347
 
    assert isinstance(branch_from, Branch)
1348
 
    assert isinstance(to_location, basestring)
1349
 
    
1350
 
    br_to = Branch.initialize(to_location)
1351
 
    br_to.set_root_id(branch_from.get_root_id())
1352
 
    if revision is None:
1353
 
        revno = branch_from.revno()
1354
 
    else:
1355
 
        revno, rev_id = RevisionSpec(revision).in_history(branch_from)
1356
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1357
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1358
 
          check_clean=False, ignore_zero=True)
1359
 
    br_to.set_parent(branch_from.base)
1360
 
    return br_to
 
824
    return '-'.join((name, compact_date(time.time()), s))
 
825
 
 
826