~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 07:29:44 UTC
  • Revision ID: mbp@sourcefrog.net-20050309072944-375a1880a9251a80
files that have been deleted are not considered present in the WorkingTree

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
20
21
from sets import Set
21
22
import os.path, os, fnmatch
22
23
 
23
 
from osutils import pumpfile, filesize, quotefn, sha_file, \
24
 
     joinpath, splitpath, appendpath, isdir, isfile, file_kind, fingerprint_file
25
 
import errno
26
 
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
27
 
 
28
24
from inventory import Inventory
29
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
30
28
from errors import bailout
31
29
import branch
 
30
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
32
31
 
33
32
import bzrlib
34
33
 
35
 
class Tree(object):
 
34
class Tree:
36
35
    """Abstract file tree.
37
36
 
38
37
    There are several subclasses:
61
60
    def has_id(self, file_id):
62
61
        return self.inventory.has_id(file_id)
63
62
 
64
 
    __contains__ = has_id
65
 
 
66
 
    def __iter__(self):
67
 
        return iter(self.inventory)
 
63
    def id_set(self):
 
64
        """Return set of all ids in this tree."""
 
65
        return self.inventory.id_set()
68
66
 
69
67
    def id2path(self, file_id):
70
68
        return self.inventory.id2path(file_id)
76
74
                         doc="Inventory of this Tree")
77
75
 
78
76
    def _check_retrieved(self, ie, f):
79
 
        fp = fingerprint_file(f)
80
 
        f.seek(0)
81
 
        
82
 
        if ie.text_size != None:
83
 
            if ie.text_size != fp['size']:
 
77
        # TODO: Test this check by damaging the store?
 
78
        if ie.text_size is not None:
 
79
            fs = filesize(f)
 
80
            if fs != ie.text_size:
84
81
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
85
82
                        ["inventory expects %d bytes" % ie.text_size,
86
 
                         "file is actually %d bytes" % fp['size'],
 
83
                         "file is actually %d bytes" % fs,
87
84
                         "store is probably damaged/corrupt"])
88
85
 
89
 
        if ie.text_sha1 != fp['sha1']:
 
86
        f_hash = sha_file(f)
 
87
        f.seek(0)
 
88
        if ie.text_sha1 != f_hash:
90
89
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
91
90
                    ["inventory expects %s" % ie.text_sha1,
92
 
                     "file is actually %s" % fp['sha1'],
 
91
                     "file is actually %s" % f_hash,
93
92
                     "store is probably damaged/corrupt"])
94
93
 
95
94
 
96
 
    def print_file(self, fileid):
97
 
        """Print file with id `fileid` to stdout."""
98
 
        import sys
99
 
        pumpfile(self.get_file(fileid), sys.stdout)
100
 
        
101
 
        
102
 
    def export(self, dest):        
 
95
    def export(self, dest):
103
96
        """Export this tree to a new directory.
104
97
 
105
98
        `dest` should not exist, and will be created holding the
106
99
        contents of this tree.
107
100
 
108
 
        TODO: To handle subdirectories we need to create the
 
101
        :todo: To handle subdirectories we need to create the
109
102
               directories first.
110
103
 
111
104
        :note: If the export fails, the destination directory will be
122
115
            elif kind == 'file':
123
116
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
124
117
            else:
125
 
                bailout("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
 
118
                bailout("don't know how to export {%s} of kind %r", fid, kind)
126
119
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
127
120
 
128
121
 
129
122
 
 
123
class WorkingTree(Tree):
 
124
    """Working copy tree.
 
125
 
 
126
    The inventory is held in the `Branch` working-inventory, and the
 
127
    files are in a directory on disk.
 
128
 
 
129
    It is possible for a `WorkingTree` to have a filename which is
 
130
    not listed in the Inventory and vice versa.
 
131
    """
 
132
    def __init__(self, basedir, inv):
 
133
        self._inventory = inv
 
134
        self.basedir = basedir
 
135
        self.path2id = inv.path2id
 
136
 
 
137
    def __repr__(self):
 
138
        return "<%s of %s>" % (self.__class__.__name__,
 
139
                               self.basedir)
 
140
 
 
141
    def _rel(self, filename):
 
142
        return os.path.join(self.basedir, filename)
 
143
 
 
144
    def has_filename(self, filename):
 
145
        return os.path.exists(self._rel(filename))
 
146
 
 
147
    def get_file(self, file_id):
 
148
        return self.get_file_byname(self.id2path(file_id))
 
149
 
 
150
    def get_file_byname(self, filename):
 
151
        return file(self._rel(filename), 'rb')
 
152
 
 
153
    def _get_store_filename(self, file_id):
 
154
        return self._rel(self.id2path(file_id))
 
155
 
 
156
    def has_id(self, file_id):
 
157
        # files that have been deleted are excluded
 
158
        if not self.inventory.has_id(file_id):
 
159
            return False
 
160
        return os.access(self._rel(self.inventory.id2path(file_id)), os.F_OK)
 
161
 
 
162
    def get_file_size(self, file_id):
 
163
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
 
164
 
 
165
    def get_file_sha1(self, file_id):
 
166
        f = self.get_file(file_id)
 
167
        return sha_file(f)
 
168
 
 
169
 
 
170
    def file_class(self, filename):
 
171
        if self.path2id(filename):
 
172
            return 'V'
 
173
        elif self.is_ignored(filename):
 
174
            return 'I'
 
175
        else:
 
176
            return '?'
 
177
 
 
178
 
 
179
    def file_kind(self, filename):
 
180
        if isfile(self._rel(filename)):
 
181
            return 'file'
 
182
        elif isdir(self._rel(filename)):
 
183
            return 'directory'
 
184
        else:
 
185
            return 'unknown'
 
186
 
 
187
 
 
188
    def list_files(self):
 
189
        """Recursively list all files as (path, class, kind, id).
 
190
 
 
191
        Lists, but does not descend into unversioned directories.
 
192
 
 
193
        This does not include files that have been deleted in this
 
194
        tree.
 
195
 
 
196
        Skips the control directory.
 
197
        """
 
198
        inv = self.inventory
 
199
 
 
200
        def descend(from_dir, from_dir_id, dp):
 
201
            ls = os.listdir(dp)
 
202
            ls.sort()
 
203
            for f in ls:
 
204
                if bzrlib.BZRDIR == f:
 
205
                    continue
 
206
 
 
207
                # path within tree
 
208
                fp = appendpath(from_dir, f)
 
209
 
 
210
                # absolute path
 
211
                fap = appendpath(dp, f)
 
212
                
 
213
                f_ie = inv.get_child(from_dir_id, f)
 
214
                if f_ie:
 
215
                    c = 'V'
 
216
                elif self.is_ignored(fp):
 
217
                    c = 'I'
 
218
                else:
 
219
                    c = '?'
 
220
 
 
221
                fk = file_kind(fap)
 
222
 
 
223
                if f_ie:
 
224
                    if f_ie.kind != fk:
 
225
                        bailout("file %r entered as kind %r id %r, now of kind %r"
 
226
                                % (fap, f_ie.kind, f_ie.file_id, fk))
 
227
 
 
228
                yield fp, c, fk, (f_ie and f_ie.file_id)
 
229
 
 
230
                if fk != 'directory':
 
231
                    continue
 
232
 
 
233
                if c != 'V':
 
234
                    # don't descend unversioned directories
 
235
                    continue
 
236
                
 
237
                for ff in descend(fp, f_ie.file_id, fap):
 
238
                    yield ff
 
239
 
 
240
        for f in descend('', None, self.basedir):
 
241
            yield f
 
242
            
 
243
 
 
244
 
 
245
    def unknowns(self, path='', dir_id=None):
 
246
        """Yield names of unknown files in this WorkingTree.
 
247
 
 
248
        If there are any unknown directories then only the directory is
 
249
        returned, not all its children.  But if there are unknown files
 
250
        under a versioned subdirectory, they are returned.
 
251
 
 
252
        Currently returned depth-first, sorted by name within directories.
 
253
        """
 
254
        for fpath, fclass, fkind, fid in self.list_files():
 
255
            if fclass == '?':
 
256
                yield fpath
 
257
                
 
258
 
 
259
    def ignored_files(self):
 
260
        for fpath, fclass, fkind, fid in self.list_files():
 
261
            if fclass == 'I':
 
262
                yield fpath
 
263
 
 
264
 
 
265
    def get_ignore_list(self):
 
266
        """Return list of ignore patterns."""
 
267
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
268
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
269
            return [line.rstrip("\n\r") for line in f.readlines()]
 
270
        else:
 
271
            return bzrlib.DEFAULT_IGNORE
 
272
 
 
273
 
 
274
    def is_ignored(self, filename):
 
275
        """Check whether the filename matches an ignore pattern.
 
276
 
 
277
        Patterns containing '/' need to match the whole path; others
 
278
        match against only the last component."""
 
279
        ## TODO: Take them from a file, not hardcoded
 
280
        ## TODO: Use extended zsh-style globs maybe?
 
281
        ## TODO: Use '**' to match directories?
 
282
        for pat in self.get_ignore_list():
 
283
            if '/' in pat:
 
284
                if fnmatch.fnmatchcase(filename, pat):
 
285
                    return True
 
286
            else:
 
287
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
288
                    return True
 
289
        return False
 
290
        
 
291
 
 
292
        
 
293
        
 
294
 
130
295
class RevisionTree(Tree):
131
296
    """Tree viewing a previous revision.
132
297
 
133
298
    File text can be retrieved from the text store.
134
299
 
135
 
    TODO: Some kind of `__repr__` method, but a good one
 
300
    :todo: Some kind of `__repr__` method, but a good one
136
301
           probably means knowing the branch and revision number,
137
302
           or at least passing a description to the constructor.
138
303
    """
145
310
        ie = self._inventory[file_id]
146
311
        f = self._store[ie.text_id]
147
312
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
313
        fs = filesize(f)
 
314
        if ie.text_size is None:
 
315
            note("warning: no text size recorded on %r" % ie)
148
316
        self._check_retrieved(ie, f)
149
317
        return f
150
318
 
232
400
 
233
401
    
234
402
 
235
 
def find_renames(old_inv, new_inv):
236
 
    for file_id in old_inv:
237
 
        if file_id not in new_inv:
238
 
            continue
239
 
        old_name = old_inv.id2path(file_id)
240
 
        new_name = new_inv.id2path(file_id)
241
 
        if old_name != new_name:
242
 
            yield (old_name, new_name)
243