~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-06-10 09:42:14 UTC
  • Revision ID: mbp@sourcefrog.net-20050610094214-644149de33083153
- fix sweeping bar progress indicator

Show diffs side-by-side

added added

removed removed

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