~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Robert Collins
  • Date: 2006-01-05 22:30:59 UTC
  • mto: (1534.1.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1536.
  • Revision ID: robertc@robertcollins.net-20060105223059-a8b64f7b47cf12fb
 * bzrlib.osutils.safe_unicode now exists to provide parameter coercion
   for functions that need unicode strings. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
42
42
# copy, and making sure there's only one WorkingTree for any directory on disk.
43
43
# At the momenthey may alias the inventory and have old copies of it in memory.
44
44
 
 
45
from copy import deepcopy
45
46
import os
46
47
import stat
47
48
import fnmatch
48
49
 
49
 
from bzrlib.branch import Branch, needs_read_lock, needs_write_lock, quotefn
50
 
import bzrlib.tree
 
50
from bzrlib.branch import (Branch,
 
51
                           is_control_file,
 
52
                           needs_read_lock,
 
53
                           needs_write_lock,
 
54
                           quotefn)
 
55
from bzrlib.errors import (BzrCheckError,
 
56
                           BzrError,
 
57
                           DivergedBranches,
 
58
                           WeaveRevisionNotPresent,
 
59
                           NotBranchError,
 
60
                           NotVersionedError)
 
61
from bzrlib.inventory import InventoryEntry
51
62
from bzrlib.osutils import (appendpath,
 
63
                            compact_date,
52
64
                            file_kind,
53
65
                            isdir,
 
66
                            getcwd,
 
67
                            pathjoin,
54
68
                            pumpfile,
55
69
                            splitpath,
56
 
                            relpath)
57
 
from bzrlib.errors import BzrCheckError, DivergedBranches, NotVersionedError
 
70
                            rand_bytes,
 
71
                            abspath,
 
72
                            normpath,
 
73
                            realpath,
 
74
                            relpath,
 
75
                            rename)
 
76
from bzrlib.textui import show_status
 
77
import bzrlib.tree
58
78
from bzrlib.trace import mutter
59
79
import bzrlib.xml5
60
80
 
61
81
 
 
82
def gen_file_id(name):
 
83
    """Return new file id.
 
84
 
 
85
    This should probably generate proper UUIDs, but for the moment we
 
86
    cope with just randomness because running uuidgen every time is
 
87
    slow."""
 
88
    import re
 
89
    from binascii import hexlify
 
90
    from time import time
 
91
 
 
92
    # get last component
 
93
    idx = name.rfind('/')
 
94
    if idx != -1:
 
95
        name = name[idx+1 : ]
 
96
    idx = name.rfind('\\')
 
97
    if idx != -1:
 
98
        name = name[idx+1 : ]
 
99
 
 
100
    # make it not a hidden file
 
101
    name = name.lstrip('.')
 
102
 
 
103
    # remove any wierd characters; we don't escape them but rather
 
104
    # just pull them out
 
105
    name = re.sub(r'[^\w.]', '', name)
 
106
 
 
107
    s = hexlify(rand_bytes(8))
 
108
    return '-'.join((name, compact_date(time()), s))
 
109
 
 
110
 
 
111
def gen_root_id():
 
112
    """Return a new tree-root file id."""
 
113
    return gen_file_id('TREE_ROOT')
 
114
 
 
115
 
62
116
class TreeEntry(object):
63
117
    """An entry that implements the minium interface used by commands.
64
118
 
124
178
    not listed in the Inventory and vice versa.
125
179
    """
126
180
 
127
 
    def __init__(self, basedir, branch=None):
 
181
    def __init__(self, basedir=u'.', branch=None):
128
182
        """Construct a WorkingTree for basedir.
129
183
 
130
184
        If the branch is not supplied, it is opened automatically.
141
195
        assert isinstance(branch, Branch), \
142
196
            "branch %r is not a Branch" % branch
143
197
        self.branch = branch
144
 
        self.basedir = basedir
145
 
        self._inventory = self.read_working_inventory()
146
 
        self.path2id = self._inventory.path2id
 
198
        self.basedir = realpath(basedir)
147
199
 
148
200
        # update the whole cache up front and write to disk if anything changed;
149
201
        # in the future we might want to do this more selectively
159
211
            mutter("write hc")
160
212
            hc.write()
161
213
 
 
214
        self._set_inventory(self.read_working_inventory())
 
215
 
 
216
    def _set_inventory(self, inv):
 
217
        self._inventory = inv
 
218
        self.path2id = self._inventory.path2id
 
219
 
 
220
    @staticmethod
 
221
    def open_containing(path=None):
 
222
        """Open an existing working tree which has its root about path.
 
223
        
 
224
        This probes for a working tree at path and searches upwards from there.
 
225
 
 
226
        Basically we keep looking up until we find the control directory or
 
227
        run into /.  If there isn't one, raises NotBranchError.
 
228
        TODO: give this a new exception.
 
229
        If there is one, it is returned, along with the unused portion of path.
 
230
        """
 
231
        if path is None:
 
232
            path = getcwd()
 
233
        else:
 
234
            # sanity check.
 
235
            if path.find('://') != -1:
 
236
                raise NotBranchError(path=path)
 
237
        path = abspath(path)
 
238
        tail = u''
 
239
        while True:
 
240
            try:
 
241
                return WorkingTree(path), tail
 
242
            except NotBranchError:
 
243
                pass
 
244
            if tail:
 
245
                tail = pathjoin(os.path.basename(path), tail)
 
246
            else:
 
247
                tail = os.path.basename(path)
 
248
            lastpath = path
 
249
            path = os.path.dirname(path)
 
250
            if lastpath == path:
 
251
                # reached the root, whatever that may be
 
252
                raise NotBranchError(path=path)
 
253
 
162
254
    def __iter__(self):
163
255
        """Iterate through file_ids for this tree.
164
256
 
170
262
            if bzrlib.osutils.lexists(self.abspath(path)):
171
263
                yield ie.file_id
172
264
 
173
 
 
174
265
    def __repr__(self):
175
266
        return "<%s of %s>" % (self.__class__.__name__,
176
267
                               getattr(self, 'basedir', None))
177
268
 
178
 
 
179
 
 
180
269
    def abspath(self, filename):
181
 
        return os.path.join(self.basedir, filename)
 
270
        return pathjoin(self.basedir, filename)
182
271
 
183
 
    def relpath(self, abspath):
 
272
    def relpath(self, abs):
184
273
        """Return the local path portion from a given absolute path."""
185
 
        return relpath(self.basedir, abspath)
 
274
        return relpath(self.basedir, abs)
186
275
 
187
276
    def has_filename(self, filename):
188
277
        return bzrlib.osutils.lexists(self.abspath(filename))
199
288
        return inv.root.file_id
200
289
        
201
290
    def _get_store_filename(self, file_id):
202
 
        ## XXX: badly named; this isn't in the store at all
 
291
        ## XXX: badly named; this is not in the store at all
203
292
        return self.abspath(self.id2path(file_id))
204
293
 
205
294
    @needs_write_lock
206
295
    def commit(self, *args, **kw):
207
296
        from bzrlib.commit import Commit
208
297
        Commit().commit(self.branch, *args, **kw)
209
 
        self._inventory = self.read_working_inventory()
 
298
        self._set_inventory(self.read_working_inventory())
210
299
 
211
300
    def id2abspath(self, file_id):
212
301
        return self.abspath(self.id2path(file_id))
213
302
 
214
 
                
215
303
    def has_id(self, file_id):
216
304
        # files that have been deleted are excluded
217
305
        inv = self._inventory
226
314
        return self.inventory.has_id(file_id)
227
315
 
228
316
    __contains__ = has_id
229
 
    
230
317
 
231
318
    def get_file_size(self, file_id):
232
319
        return os.path.getsize(self.id2abspath(file_id))
233
320
 
 
321
    @needs_read_lock
234
322
    def get_file_sha1(self, file_id):
235
323
        path = self._inventory.id2path(file_id)
236
324
        return self._hashcache.get_sha1(path)
237
325
 
238
 
 
239
326
    def is_executable(self, file_id):
240
327
        if os.name == "nt":
241
328
            return self._inventory[file_id].executable
245
332
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
246
333
 
247
334
    @needs_write_lock
 
335
    def add(self, files, ids=None):
 
336
        """Make files versioned.
 
337
 
 
338
        Note that the command line normally calls smart_add instead,
 
339
        which can automatically recurse.
 
340
 
 
341
        This adds the files to the inventory, so that they will be
 
342
        recorded by the next commit.
 
343
 
 
344
        files
 
345
            List of paths to add, relative to the base of the tree.
 
346
 
 
347
        ids
 
348
            If set, use these instead of automatically generated ids.
 
349
            Must be the same length as the list of files, but may
 
350
            contain None for ids that are to be autogenerated.
 
351
 
 
352
        TODO: Perhaps have an option to add the ids even if the files do
 
353
              not (yet) exist.
 
354
 
 
355
        TODO: Perhaps callback with the ids and paths as they're added.
 
356
        """
 
357
        # TODO: Re-adding a file that is removed in the working copy
 
358
        # should probably put it back with the previous ID.
 
359
        if isinstance(files, basestring):
 
360
            assert(ids is None or isinstance(ids, basestring))
 
361
            files = [files]
 
362
            if ids is not None:
 
363
                ids = [ids]
 
364
 
 
365
        if ids is None:
 
366
            ids = [None] * len(files)
 
367
        else:
 
368
            assert(len(ids) == len(files))
 
369
 
 
370
        inv = self.read_working_inventory()
 
371
        for f,file_id in zip(files, ids):
 
372
            if is_control_file(f):
 
373
                raise BzrError("cannot add control file %s" % quotefn(f))
 
374
 
 
375
            fp = splitpath(f)
 
376
 
 
377
            if len(fp) == 0:
 
378
                raise BzrError("cannot add top-level %r" % f)
 
379
 
 
380
            fullpath = normpath(self.abspath(f))
 
381
 
 
382
            try:
 
383
                kind = file_kind(fullpath)
 
384
            except OSError:
 
385
                # maybe something better?
 
386
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
 
387
 
 
388
            if not InventoryEntry.versionable_kind(kind):
 
389
                raise BzrError('cannot add: not a versionable file ('
 
390
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
 
391
 
 
392
            if file_id is None:
 
393
                file_id = gen_file_id(f)
 
394
            inv.add_path(f, kind=kind, file_id=file_id)
 
395
 
 
396
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
397
        self._write_inventory(inv)
 
398
 
 
399
    @needs_write_lock
248
400
    def add_pending_merge(self, *revision_ids):
249
401
        # TODO: Perhaps should check at this point that the
250
402
        # history of the revision is actually present?
357
509
                for ff in descend(fp, f_ie.file_id, fap):
358
510
                    yield ff
359
511
 
360
 
        for f in descend('', inv.root.file_id, self.basedir):
 
512
        for f in descend(u'', inv.root.file_id, self.basedir):
361
513
            yield f
362
 
            
363
 
 
364
 
 
 
514
 
 
515
    @needs_write_lock
 
516
    def move(self, from_paths, to_name):
 
517
        """Rename files.
 
518
 
 
519
        to_name must exist in the inventory.
 
520
 
 
521
        If to_name exists and is a directory, the files are moved into
 
522
        it, keeping their old names.  
 
523
 
 
524
        Note that to_name is only the last component of the new name;
 
525
        this doesn't change the directory.
 
526
 
 
527
        This returns a list of (from_path, to_path) pairs for each
 
528
        entry that is moved.
 
529
        """
 
530
        result = []
 
531
        ## TODO: Option to move IDs only
 
532
        assert not isinstance(from_paths, basestring)
 
533
        inv = self.inventory
 
534
        to_abs = self.abspath(to_name)
 
535
        if not isdir(to_abs):
 
536
            raise BzrError("destination %r is not a directory" % to_abs)
 
537
        if not self.has_filename(to_name):
 
538
            raise BzrError("destination %r not in working directory" % to_abs)
 
539
        to_dir_id = inv.path2id(to_name)
 
540
        if to_dir_id == None and to_name != '':
 
541
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
542
        to_dir_ie = inv[to_dir_id]
 
543
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
544
            raise BzrError("destination %r is not a directory" % to_abs)
 
545
 
 
546
        to_idpath = inv.get_idpath(to_dir_id)
 
547
 
 
548
        for f in from_paths:
 
549
            if not self.has_filename(f):
 
550
                raise BzrError("%r does not exist in working tree" % f)
 
551
            f_id = inv.path2id(f)
 
552
            if f_id == None:
 
553
                raise BzrError("%r is not versioned" % f)
 
554
            name_tail = splitpath(f)[-1]
 
555
            dest_path = appendpath(to_name, name_tail)
 
556
            if self.has_filename(dest_path):
 
557
                raise BzrError("destination %r already exists" % dest_path)
 
558
            if f_id in to_idpath:
 
559
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
560
 
 
561
        # OK, so there's a race here, it's possible that someone will
 
562
        # create a file in this interval and then the rename might be
 
563
        # left half-done.  But we should have caught most problems.
 
564
        orig_inv = deepcopy(self.inventory)
 
565
        try:
 
566
            for f in from_paths:
 
567
                name_tail = splitpath(f)[-1]
 
568
                dest_path = appendpath(to_name, name_tail)
 
569
                result.append((f, dest_path))
 
570
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
571
                try:
 
572
                    rename(self.abspath(f), self.abspath(dest_path))
 
573
                except OSError, e:
 
574
                    raise BzrError("failed to rename %r to %r: %s" %
 
575
                                   (f, dest_path, e[1]),
 
576
                            ["rename rolled back"])
 
577
        except:
 
578
            # restore the inventory on error
 
579
            self._set_inventory(orig_inv)
 
580
            raise
 
581
        self._write_inventory(inv)
 
582
        return result
 
583
 
 
584
    @needs_write_lock
 
585
    def rename_one(self, from_rel, to_rel):
 
586
        """Rename one file.
 
587
 
 
588
        This can change the directory or the filename or both.
 
589
        """
 
590
        inv = self.inventory
 
591
        if not self.has_filename(from_rel):
 
592
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
593
        if self.has_filename(to_rel):
 
594
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
595
 
 
596
        file_id = inv.path2id(from_rel)
 
597
        if file_id == None:
 
598
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
599
 
 
600
        entry = inv[file_id]
 
601
        from_parent = entry.parent_id
 
602
        from_name = entry.name
 
603
        
 
604
        if inv.path2id(to_rel):
 
605
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
606
 
 
607
        to_dir, to_tail = os.path.split(to_rel)
 
608
        to_dir_id = inv.path2id(to_dir)
 
609
        if to_dir_id == None and to_dir != '':
 
610
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
611
 
 
612
        mutter("rename_one:")
 
613
        mutter("  file_id    {%s}" % file_id)
 
614
        mutter("  from_rel   %r" % from_rel)
 
615
        mutter("  to_rel     %r" % to_rel)
 
616
        mutter("  to_dir     %r" % to_dir)
 
617
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
618
 
 
619
        inv.rename(file_id, to_dir_id, to_tail)
 
620
 
 
621
        from_abs = self.abspath(from_rel)
 
622
        to_abs = self.abspath(to_rel)
 
623
        try:
 
624
            rename(from_abs, to_abs)
 
625
        except OSError, e:
 
626
            inv.rename(file_id, from_parent, from_name)
 
627
            raise BzrError("failed to rename %r to %r: %s"
 
628
                    % (from_abs, to_abs, e[1]),
 
629
                    ["rename rolled back"])
 
630
        self._write_inventory(inv)
 
631
 
 
632
    @needs_read_lock
365
633
    def unknowns(self):
 
634
        """Return all unknown files.
 
635
 
 
636
        These are files in the working directory that are not versioned or
 
637
        control files or ignored.
 
638
        
 
639
        >>> from bzrlib.branch import ScratchBranch
 
640
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
641
        >>> tree = WorkingTree(b.base, b)
 
642
        >>> map(str, tree.unknowns())
 
643
        ['foo']
 
644
        >>> tree.add('foo')
 
645
        >>> list(b.unknowns())
 
646
        []
 
647
        >>> tree.remove('foo')
 
648
        >>> list(b.unknowns())
 
649
        [u'foo']
 
650
        """
366
651
        for subp in self.extras():
367
652
            if not self.is_ignored(subp):
368
653
                yield subp
383
668
        source.lock_read()
384
669
        try:
385
670
            old_revision_history = self.branch.revision_history()
386
 
            self.branch.pull(source, overwrite)
 
671
            count = self.branch.pull(source, overwrite)
387
672
            new_revision_history = self.branch.revision_history()
388
673
            if new_revision_history != old_revision_history:
389
674
                if len(old_revision_history):
393
678
                merge_inner(self.branch,
394
679
                            self.branch.basis_tree(), 
395
680
                            self.branch.revision_tree(other_revision))
 
681
            return count
396
682
        finally:
397
683
            source.unlock()
398
684
 
498
784
        """See Branch.lock_write, and WorkingTree.unlock."""
499
785
        return self.branch.lock_write()
500
786
 
 
787
    def _basis_inventory_name(self, revision_id):
 
788
        return 'basis-inventory.%s' % revision_id
 
789
 
 
790
    def set_last_revision(self, new_revision, old_revision=None):
 
791
        if old_revision:
 
792
            try:
 
793
                path = self._basis_inventory_name(old_revision)
 
794
                path = self.branch._rel_controlfilename(path)
 
795
                self.branch._transport.delete(path)
 
796
            except:
 
797
                pass
 
798
        try:
 
799
            xml = self.branch.get_inventory_xml(new_revision)
 
800
            path = self._basis_inventory_name(new_revision)
 
801
            self.branch.put_controlfile(path, xml)
 
802
        except WeaveRevisionNotPresent:
 
803
            pass
 
804
 
 
805
    def read_basis_inventory(self, revision_id):
 
806
        """Read the cached basis inventory."""
 
807
        path = self._basis_inventory_name(revision_id)
 
808
        return self.branch.controlfile(path, 'r').read()
 
809
        
501
810
    @needs_read_lock
502
811
    def read_working_inventory(self):
503
812
        """Read the working inventory."""
605
914
        between multiple working trees, i.e. via shared storage, then we 
606
915
        would probably want to lock both the local tree, and the branch.
607
916
        """
 
917
        if self._hashcache.needs_write:
 
918
            self._hashcache.write()
608
919
        return self.branch.unlock()
609
920
 
610
921
    @needs_write_lock
621
932
            f.commit()
622
933
        finally:
623
934
            f.close()
 
935
        self._set_inventory(inv)
624
936
        mutter('wrote working inventory')
625
937
            
626
938