~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-23 06:25:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050323062555-5489339018d0c043
- import a subset of elementtree for easier installation

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