/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

and the tutorial patch came back, the very next day

Show diffs side-by-side

added added

removed removed

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