~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:09:29 UTC
  • Revision ID: mbp@sourcefrog.net-20050309040929-eee0eb3e6d1e7627
add python bytecode to default ignore pattern

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
2
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
17
18
"""Tree classes, representing directory at point in time.
18
19
"""
19
20
 
20
 
import os
21
 
from cStringIO import StringIO
 
21
from sets import Set
 
22
import os.path, os, fnmatch
 
23
 
 
24
from inventory import Inventory
 
25
from trace import mutter, note
 
26
from osutils import pumpfile, compare_files, filesize, quotefn, sha_file, \
 
27
     joinpath, splitpath, appendpath, isdir, isfile, file_kind
 
28
from errors import bailout
 
29
import branch
 
30
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
22
31
 
23
32
import bzrlib
24
 
from bzrlib.trace import mutter, note
25
 
from bzrlib.errors import BzrError, BzrCheckError
26
 
from bzrlib.inventory import Inventory
27
 
from bzrlib.osutils import appendpath, fingerprint_file
28
33
 
29
 
class Tree(object):
 
34
class Tree:
30
35
    """Abstract file tree.
31
36
 
32
37
    There are several subclasses:
48
53
    trees or versioned trees.
49
54
    """
50
55
    
 
56
    def get_file(self, file_id):
 
57
        """Return an open file-like object for given file id."""
 
58
        raise NotImplementedError()
 
59
 
51
60
    def has_filename(self, filename):
52
61
        """True if the tree has given filename."""
53
62
        raise NotImplementedError()
55
64
    def has_id(self, file_id):
56
65
        return self.inventory.has_id(file_id)
57
66
 
58
 
    def has_or_had_id(self, file_id):
59
 
        if file_id == self.inventory.root.file_id:
60
 
            return True
61
 
        return self.inventory.has_id(file_id)
62
 
 
63
 
    __contains__ = has_id
64
 
 
65
 
    def __iter__(self):
66
 
        return iter(self.inventory)
 
67
    def id_set(self):
 
68
        """Return set of all ids in this tree."""
 
69
        return self.inventory.id_set()
67
70
 
68
71
    def id2path(self, file_id):
69
72
        return self.inventory.id2path(file_id)
70
73
 
71
 
    def kind(self, file_id):
72
 
        raise NotImplementedError("subclasses must implement kind")
73
 
 
74
74
    def _get_inventory(self):
75
75
        return self._inventory
76
 
    
77
 
    def get_file_by_path(self, path):
78
 
        return self.get_file(self._inventory.path2id(path))
79
76
 
80
77
    inventory = property(_get_inventory,
81
78
                         doc="Inventory of this Tree")
82
79
 
83
80
    def _check_retrieved(self, ie, f):
84
 
        if not __debug__:
85
 
            return  
86
 
        fp = fingerprint_file(f)
87
 
        f.seek(0)
88
 
        
89
 
        if ie.text_size != None:
90
 
            if ie.text_size != fp['size']:
91
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
81
        # TODO: Test this check by damaging the store?
 
82
        if ie.text_size is not None:
 
83
            fs = filesize(f)
 
84
            if fs != ie.text_size:
 
85
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
92
86
                        ["inventory expects %d bytes" % ie.text_size,
93
 
                         "file is actually %d bytes" % fp['size'],
 
87
                         "file is actually %d bytes" % fs,
94
88
                         "store is probably damaged/corrupt"])
95
89
 
96
 
        if ie.text_sha1 != fp['sha1']:
97
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
90
        f_hash = sha_file(f)
 
91
        f.seek(0)
 
92
        if ie.text_sha1 != f_hash:
 
93
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
98
94
                    ["inventory expects %s" % ie.text_sha1,
99
 
                     "file is actually %s" % fp['sha1'],
 
95
                     "file is actually %s" % f_hash,
100
96
                     "store is probably damaged/corrupt"])
101
97
 
102
98
 
103
 
    def print_file(self, file_id):
104
 
        """Print file with id `file_id` to stdout."""
105
 
        import sys
106
 
        sys.stdout.write(self.get_file_text(file_id))
107
 
 
108
 
    def lock_read(self):
109
 
        pass
110
 
 
111
 
    def unlock(self):
112
 
        pass
113
 
 
114
 
    def filter_unversioned_files(self, paths):
115
 
        """Filter out paths that are not versioned.
116
 
 
117
 
        :return: set of paths.
118
 
        """
119
 
        # NB: we specifically *don't* call self.has_filename, because for
120
 
        # WorkingTrees that can indicate files that exist on disk but that 
121
 
        # are not versioned.
122
 
        pred = self.inventory.has_filename
123
 
        return set((p for p in paths if not pred(p)))
124
 
        
125
 
        
 
99
    def export(self, dest):
 
100
        """Export this tree to a new directory.
 
101
 
 
102
        `dest` should not exist, and will be created holding the
 
103
        contents of this tree.
 
104
 
 
105
        :todo: To handle subdirectories we need to create the
 
106
               directories first.
 
107
 
 
108
        :note: If the export fails, the destination directory will be
 
109
               left in a half-assed state.
 
110
        """
 
111
        os.mkdir(dest)
 
112
        mutter('export version %r' % self)
 
113
        inv = self.inventory
 
114
        for dp, ie in inv.iter_entries():
 
115
            kind = ie.kind
 
116
            fullpath = appendpath(dest, dp)
 
117
            if kind == 'directory':
 
118
                os.mkdir(fullpath)
 
119
            elif kind == 'file':
 
120
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
 
121
            else:
 
122
                bailout("don't know how to export {%s} of kind %r", fid, kind)
 
123
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
124
 
 
125
 
 
126
 
 
127
class WorkingTree(Tree):
 
128
    """Working copy tree.
 
129
 
 
130
    The inventory is held in the `Branch` working-inventory, and the
 
131
    files are in a directory on disk.
 
132
 
 
133
    It is possible for a `WorkingTree` to have a filename which is
 
134
    not listed in the Inventory and vice versa.
 
135
    """
 
136
    def __init__(self, basedir, inv):
 
137
        self._inventory = inv
 
138
        self.basedir = basedir
 
139
        self.path2id = inv.path2id
 
140
 
 
141
    def __repr__(self):
 
142
        return "<%s of %s>" % (self.__class__.__name__,
 
143
                               self.basedir)
 
144
 
 
145
    def _rel(self, filename):
 
146
        return os.path.join(self.basedir, filename)
 
147
 
 
148
    def has_filename(self, filename):
 
149
        return os.path.exists(self._rel(filename))
 
150
 
 
151
    def get_file(self, file_id):
 
152
        return file(self._get_store_filename(file_id), 'rb')
 
153
 
 
154
    def _get_store_filename(self, file_id):
 
155
        return self._rel(self.id2path(file_id))
 
156
 
 
157
    def get_file_size(self, file_id):
 
158
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
 
159
 
 
160
    def get_file_sha1(self, file_id):
 
161
        f = self.get_file(file_id)
 
162
        return sha_file(f)
 
163
 
 
164
 
 
165
    def file_class(self, filename):
 
166
        if self.path2id(filename):
 
167
            return 'V'
 
168
        elif self.is_ignored(filename):
 
169
            return 'I'
 
170
        else:
 
171
            return '?'
 
172
 
 
173
 
 
174
    def file_kind(self, filename):
 
175
        if isfile(self._rel(filename)):
 
176
            return 'file'
 
177
        elif isdir(self._rel(filename)):
 
178
            return 'directory'
 
179
        else:
 
180
            return 'unknown'
 
181
 
 
182
 
 
183
    def list_files(self):
 
184
        """Recursively list all files as (path, class, kind, id).
 
185
 
 
186
        Lists, but does not descend into unversioned directories.
 
187
 
 
188
        This does not include files that have been deleted in this
 
189
        tree.
 
190
 
 
191
        Skips the control directory.
 
192
        """
 
193
        inv = self.inventory
 
194
 
 
195
        def descend(from_dir, from_dir_id, dp):
 
196
            ls = os.listdir(dp)
 
197
            ls.sort()
 
198
            for f in ls:
 
199
                if bzrlib.BZRDIR == f:
 
200
                    continue
 
201
 
 
202
                # path within tree
 
203
                fp = appendpath(from_dir, f)
 
204
 
 
205
                # absolute path
 
206
                fap = appendpath(dp, f)
 
207
                
 
208
                f_ie = inv.get_child(from_dir_id, f)
 
209
                if f_ie:
 
210
                    c = 'V'
 
211
                elif self.is_ignored(fp):
 
212
                    c = 'I'
 
213
                else:
 
214
                    c = '?'
 
215
 
 
216
                fk = file_kind(fap)
 
217
 
 
218
                if f_ie:
 
219
                    if f_ie.kind != fk:
 
220
                        bailout("file %r entered as kind %r id %r, now of kind %r"
 
221
                                % (fap, f_ie.kind, f_ie.file_id, fk))
 
222
 
 
223
                yield fp, c, fk, (f_ie and f_ie.file_id)
 
224
 
 
225
                if fk != 'directory':
 
226
                    continue
 
227
 
 
228
                if c != 'V':
 
229
                    # don't descend unversioned directories
 
230
                    continue
 
231
                
 
232
                for ff in descend(fp, f_ie.file_id, fap):
 
233
                    yield ff
 
234
 
 
235
        for f in descend('', None, self.basedir):
 
236
            yield f
 
237
            
 
238
 
 
239
 
 
240
    def unknowns(self, path='', dir_id=None):
 
241
        """Yield names of unknown files in this WorkingTree.
 
242
 
 
243
        If there are any unknown directories then only the directory is
 
244
        returned, not all its children.  But if there are unknown files
 
245
        under a versioned subdirectory, they are returned.
 
246
 
 
247
        Currently returned depth-first, sorted by name within directories.
 
248
        """
 
249
        for fpath, fclass, fkind, fid in self.list_files():
 
250
            if fclass == '?':
 
251
                yield fpath
 
252
                
 
253
 
 
254
    def ignored_files(self):
 
255
        for fpath, fclass, fkind, fid in self.list_files():
 
256
            if fclass == 'I':
 
257
                yield fpath
 
258
 
 
259
 
 
260
    def is_ignored(self, filename):
 
261
        """Check whether the filename matches an ignore pattern."""
 
262
        ## TODO: Take them from a file, not hardcoded
 
263
        ## TODO: Use extended zsh-style globs maybe?
 
264
        ## TODO: Use '**' to match directories?
 
265
        ## TODO: Patterns without / should match in subdirectories?
 
266
        for i in bzrlib.DEFAULT_IGNORE:
 
267
            if fnmatch.fnmatchcase(filename, i):
 
268
                return True
 
269
        return False
 
270
        
 
271
 
 
272
        
 
273
        
 
274
 
126
275
class RevisionTree(Tree):
127
276
    """Tree viewing a previous revision.
128
277
 
129
278
    File text can be retrieved from the text store.
130
279
 
131
 
    TODO: Some kind of `__repr__` method, but a good one
 
280
    :todo: Some kind of `__repr__` method, but a good one
132
281
           probably means knowing the branch and revision number,
133
282
           or at least passing a description to the constructor.
134
283
    """
135
284
    
136
 
    def __init__(self, branch, inv, revision_id):
137
 
        self._branch = branch
138
 
        self._weave_store = branch.weave_store
 
285
    def __init__(self, store, inv):
 
286
        self._store = store
139
287
        self._inventory = inv
140
 
        self._revision_id = revision_id
141
 
 
142
 
    def get_weave(self, file_id):
143
 
        return self._weave_store.get_weave(file_id,
144
 
                self._branch.get_transaction())
145
 
 
146
 
    def get_file_lines(self, file_id):
 
288
 
 
289
    def get_file(self, file_id):
147
290
        ie = self._inventory[file_id]
148
 
        weave = self.get_weave(file_id)
149
 
        return weave.get_lines(ie.revision)
150
 
 
151
 
    def get_file_text(self, file_id):
152
 
        return ''.join(self.get_file_lines(file_id))
153
 
 
154
 
    def get_file(self, file_id):
155
 
        return StringIO(self.get_file_text(file_id))
 
291
        f = self._store[ie.text_id]
 
292
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
293
        fs = filesize(f)
 
294
        if ie.text_size is None:
 
295
            note("warning: no text size recorded on %r" % ie)
 
296
        self._check_retrieved(ie, f)
 
297
        return f
156
298
 
157
299
    def get_file_size(self, file_id):
158
300
        return self._inventory[file_id].text_size
159
301
 
160
302
    def get_file_sha1(self, file_id):
161
303
        ie = self._inventory[file_id]
162
 
        if ie.kind == "file":
163
 
            return ie.text_sha1
164
 
 
165
 
    def is_executable(self, file_id):
166
 
        ie = self._inventory[file_id]
167
 
        if ie.kind != "file":
168
 
            return None 
169
 
        return self._inventory[file_id].executable
 
304
        return ie.text_sha1
170
305
 
171
306
    def has_filename(self, filename):
172
307
        return bool(self.inventory.path2id(filename))
174
309
    def list_files(self):
175
310
        # The only files returned by this are those from the version
176
311
        for path, entry in self.inventory.iter_entries():
177
 
            yield path, 'V', entry.kind, entry.file_id, entry
178
 
 
179
 
    def get_symlink_target(self, file_id):
180
 
        ie = self._inventory[file_id]
181
 
        return ie.symlink_target;
182
 
 
183
 
    def kind(self, file_id):
184
 
        return self._inventory[file_id].kind
185
 
 
186
 
    def lock_read(self):
187
 
        self._branch.lock_read()
188
 
 
189
 
    def unlock(self):
190
 
        self._branch.unlock()
 
312
            yield path, 'V', entry.kind, entry.file_id
191
313
 
192
314
 
193
315
class EmptyTree(Tree):
194
316
    def __init__(self):
195
317
        self._inventory = Inventory()
196
318
 
197
 
    def get_symlink_target(self, file_id):
198
 
        return None
199
 
 
200
319
    def has_filename(self, filename):
201
320
        return False
202
321
 
203
 
    def kind(self, file_id):
204
 
        assert self._inventory[file_id].kind == "root_directory"
205
 
        return "root_directory"
206
 
 
207
322
    def list_files(self):
208
 
        return iter([])
 
323
        if False:  # just to make it a generator
 
324
            yield None
209
325
    
210
 
    def __contains__(self, file_id):
211
 
        return file_id in self._inventory
212
 
 
213
 
    def get_file_sha1(self, file_id):
214
 
        assert self._inventory[file_id].kind == "root_directory"
215
 
        return None
216
326
 
217
327
 
218
328
######################################################################
270
380
 
271
381
    
272
382
 
273
 
def find_renames(old_inv, new_inv):
274
 
    for file_id in old_inv:
275
 
        if file_id not in new_inv:
276
 
            continue
277
 
        old_name = old_inv.id2path(file_id)
278
 
        new_name = new_inv.id2path(file_id)
279
 
        if old_name != new_name:
280
 
            yield (old_name, new_name)
281
 
            
282
 
 
283