/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-05-11 08:12:23 UTC
  • Revision ID: mbp@sourcefrog.net-20050511081223-7c935881e8145274
todo

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