~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-05-03 07:48:35 UTC
  • Revision ID: mbp@sourcefrog.net-20050503074835-0133bd0c16440fcd
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# Copyright (C) 2005 Canonical Ltd
2
 
#
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
 
import os
21
 
from collections import deque
22
 
from cStringIO import StringIO
 
20
from sets import Set
 
21
import os.path, os, fnmatch
 
22
 
 
23
from osutils import pumpfile, compare_files, 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
from inventory import Inventory
 
29
from trace import mutter, note
 
30
from errors import bailout
 
31
import branch
23
32
 
24
33
import bzrlib
25
 
from bzrlib import (
26
 
    delta,
27
 
    osutils,
28
 
    revision as _mod_revision,
29
 
    symbol_versioning,
30
 
    )
31
 
from bzrlib.decorators import needs_read_lock
32
 
from bzrlib.errors import BzrError, BzrCheckError
33
 
from bzrlib import errors
34
 
from bzrlib.inventory import Inventory, InventoryFile
35
 
from bzrlib.inter import InterObject
36
 
from bzrlib.osutils import fingerprint_file
37
 
import bzrlib.revision
38
 
from bzrlib.trace import mutter, note
39
 
 
40
 
 
41
 
class Tree(object):
 
34
 
 
35
class Tree:
42
36
    """Abstract file tree.
43
37
 
44
38
    There are several subclasses:
47
41
 
48
42
    * `RevisionTree` is a tree as recorded at some point in the past.
49
43
 
 
44
    * `EmptyTree`
 
45
 
50
46
    Trees contain an `Inventory` object, and also know how to retrieve
51
47
    file texts mentioned in the inventory, either from a working
52
48
    directory or from a store.
58
54
    trees or versioned trees.
59
55
    """
60
56
    
61
 
    def changes_from(self, other, want_unchanged=False, specific_files=None,
62
 
        extra_trees=None, require_versioned=False, include_root=False,
63
 
        want_unversioned=False):
64
 
        """Return a TreeDelta of the changes from other to this tree.
65
 
 
66
 
        :param other: A tree to compare with.
67
 
        :param specific_files: An optional list of file paths to restrict the
68
 
            comparison to. When mapping filenames to ids, all matches in all
69
 
            trees (including optional extra_trees) are used, and all children of
70
 
            matched directories are included.
71
 
        :param want_unchanged: An optional boolean requesting the inclusion of
72
 
            unchanged entries in the result.
73
 
        :param extra_trees: An optional list of additional trees to use when
74
 
            mapping the contents of specific_files (paths) to file_ids.
75
 
        :param require_versioned: An optional boolean (defaults to False). When
76
 
            supplied and True all the 'specific_files' must be versioned, or
77
 
            a PathsNotVersionedError will be thrown.
78
 
        :param want_unversioned: Scan for unversioned paths.
79
 
 
80
 
        The comparison will be performed by an InterTree object looked up on 
81
 
        self and other.
82
 
        """
83
 
        # Martin observes that Tree.changes_from returns a TreeDelta and this
84
 
        # may confuse people, because the class name of the returned object is
85
 
        # a synonym of the object referenced in the method name.
86
 
        return InterTree.get(other, self).compare(
87
 
            want_unchanged=want_unchanged,
88
 
            specific_files=specific_files,
89
 
            extra_trees=extra_trees,
90
 
            require_versioned=require_versioned,
91
 
            include_root=include_root,
92
 
            want_unversioned=want_unversioned,
93
 
            )
94
 
 
95
 
    def _iter_changes(self, from_tree, include_unchanged=False,
96
 
                     specific_files=None, pb=None, extra_trees=None,
97
 
                     require_versioned=True, want_unversioned=False):
98
 
        intertree = InterTree.get(from_tree, self)
99
 
        return intertree._iter_changes(include_unchanged, specific_files, pb,
100
 
            extra_trees, require_versioned, want_unversioned=want_unversioned)
101
 
    
102
 
    def conflicts(self):
103
 
        """Get a list of the conflicts in the tree.
104
 
 
105
 
        Each conflict is an instance of bzrlib.conflicts.Conflict.
106
 
        """
107
 
        return []
108
 
 
109
 
    def extras(self):
110
 
        """For trees that can have unversioned files, return all such paths."""
111
 
        return []
112
 
 
113
 
    def get_parent_ids(self):
114
 
        """Get the parent ids for this tree. 
115
 
 
116
 
        :return: a list of parent ids. [] is returned to indicate
117
 
        a tree with no parents.
118
 
        :raises: BzrError if the parents are not known.
119
 
        """
120
 
        raise NotImplementedError(self.get_parent_ids)
121
 
    
122
57
    def has_filename(self, filename):
123
58
        """True if the tree has given filename."""
124
59
        raise NotImplementedError()
125
60
 
126
61
    def has_id(self, file_id):
127
 
        file_id = osutils.safe_file_id(file_id)
128
 
        return self.inventory.has_id(file_id)
129
 
 
130
 
    __contains__ = has_id
131
 
 
132
 
    def has_or_had_id(self, file_id):
133
 
        file_id = osutils.safe_file_id(file_id)
134
 
        if file_id == self.inventory.root.file_id:
135
 
            return True
136
 
        return self.inventory.has_id(file_id)
137
 
 
138
 
    def is_ignored(self, filename):
139
 
        """Check whether the filename is ignored by this tree.
140
 
 
141
 
        :param filename: The relative filename within the tree.
142
 
        :return: True if the filename is ignored.
143
 
        """
144
 
        return False
145
 
 
146
 
    def __iter__(self):
147
 
        return iter(self.inventory)
 
62
        return self.inventory.has_id(file_id)
 
63
 
 
64
    def id_set(self):
 
65
        """Return set of all ids in this tree."""
 
66
        return self.inventory.id_set()
148
67
 
149
68
    def id2path(self, file_id):
150
 
        """Return the path for a file id.
151
 
 
152
 
        :raises NoSuchId:
153
 
        """
154
 
        file_id = osutils.safe_file_id(file_id)
155
69
        return self.inventory.id2path(file_id)
156
70
 
157
 
    def is_control_filename(self, filename):
158
 
        """True if filename is the name of a control file in this tree.
159
 
        
160
 
        :param filename: A filename within the tree. This is a relative path
161
 
        from the root of this tree.
162
 
 
163
 
        This is true IF and ONLY IF the filename is part of the meta data
164
 
        that bzr controls in this tree. I.E. a random .bzr directory placed
165
 
        on disk will not be a control file for this tree.
166
 
        """
167
 
        return self.bzrdir.is_control_filename(filename)
168
 
 
169
 
    @needs_read_lock
170
 
    def iter_entries_by_dir(self, specific_file_ids=None):
171
 
        """Walk the tree in 'by_dir' order.
172
 
 
173
 
        This will yield each entry in the tree as a (path, entry) tuple. The
174
 
        order that they are yielded is: the contents of a directory are 
175
 
        preceeded by the parent of a directory, and all the contents of a 
176
 
        directory are grouped together.
177
 
        """
178
 
        return self.inventory.iter_entries_by_dir(
179
 
            specific_file_ids=specific_file_ids)
180
 
 
181
 
    def iter_references(self):
182
 
        for path, entry in self.iter_entries_by_dir():
183
 
            if entry.kind == 'tree-reference':
184
 
                yield path, entry.file_id
185
 
 
186
 
    def kind(self, file_id):
187
 
        raise NotImplementedError("Tree subclass %s must implement kind"
188
 
            % self.__class__.__name__)
189
 
 
190
 
    def get_reference_revision(self, file_id, path=None):
191
 
        raise NotImplementedError("Tree subclass %s must implement "
192
 
                                  "get_reference_revision"
193
 
            % self.__class__.__name__)
194
 
 
195
 
    def _comparison_data(self, entry, path):
196
 
        """Return a tuple of kind, executable, stat_value for a file.
197
 
 
198
 
        entry may be None if there is no inventory entry for the file, but
199
 
        path must always be supplied.
200
 
 
201
 
        kind is None if there is no file present (even if an inventory id is
202
 
        present).  executable is False for non-file entries.
203
 
        """
204
 
        raise NotImplementedError(self._comparison_data)
205
 
 
206
 
    def _file_size(self, entry, stat_value):
207
 
        raise NotImplementedError(self._file_size)
208
 
 
209
71
    def _get_inventory(self):
210
72
        return self._inventory
211
 
    
212
 
    def get_file(self, file_id):
213
 
        """Return a file object for the file file_id in the tree."""
214
 
        raise NotImplementedError(self.get_file)
215
 
 
216
 
    def get_file_mtime(self, file_id, path=None):
217
 
        """Return the modification time for a file.
218
 
 
219
 
        :param file_id: The handle for this file.
220
 
        :param path: The path that this file can be found at.
221
 
            These must point to the same object.
222
 
        """
223
 
        raise NotImplementedError(self.get_file_mtime)
224
 
 
225
 
    def get_file_by_path(self, path):
226
 
        return self.get_file(self._inventory.path2id(path))
227
 
 
228
 
    def get_symlink_target(self, file_id):
229
 
        """Get the target for a given file_id.
230
 
 
231
 
        It is assumed that the caller already knows that file_id is referencing
232
 
        a symlink.
233
 
        :param file_id: Handle for the symlink entry.
234
 
        :return: The path the symlink points to.
235
 
        """
236
 
        raise NotImplementedError(self.get_symlink_target)
237
 
 
238
 
    def annotate_iter(self, file_id):
239
 
        """Return an iterator of revision_id, line tuples
240
 
 
241
 
        For working trees (and mutable trees in general), the special
242
 
        revision_id 'current:' will be used for lines that are new in this
243
 
        tree, e.g. uncommitted changes.
244
 
        :param file_id: The file to produce an annotated version from
245
 
        """
246
 
        raise NotImplementedError(self.annotate_iter)
247
 
 
248
 
    def plan_file_merge(self, file_id, other):
249
 
        """Generate a merge plan based on annotations
250
 
 
251
 
        If the file contains uncommitted changes in this tree, they will be
252
 
        attributed to the 'current:' pseudo-revision.  If the file contains
253
 
        uncommitted changes in the other tree, they will be assigned to the
254
 
        'other:' pseudo-revision.
255
 
        """
256
 
        from bzrlib import merge
257
 
        annotated_a = list(self.annotate_iter(file_id,
258
 
                                              _mod_revision.CURRENT_REVISION))
259
 
        annotated_b = list(other.annotate_iter(file_id, 'other:'))
260
 
        ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
261
 
        ancestors_b = other._get_ancestors('other:')
262
 
        return merge._plan_annotate_merge(annotated_a, annotated_b,
263
 
                                          ancestors_a, ancestors_b)
264
73
 
265
74
    inventory = property(_get_inventory,
266
75
                         doc="Inventory of this Tree")
267
76
 
268
77
    def _check_retrieved(self, ie, f):
269
 
        if not __debug__:
270
 
            return  
271
78
        fp = fingerprint_file(f)
272
79
        f.seek(0)
273
80
        
274
 
        if ie.text_size is not None:
 
81
        if ie.text_size != None:
275
82
            if ie.text_size != fp['size']:
276
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
83
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
277
84
                        ["inventory expects %d bytes" % ie.text_size,
278
85
                         "file is actually %d bytes" % fp['size'],
279
86
                         "store is probably damaged/corrupt"])
280
87
 
281
88
        if ie.text_sha1 != fp['sha1']:
282
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
89
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
283
90
                    ["inventory expects %s" % ie.text_sha1,
284
91
                     "file is actually %s" % fp['sha1'],
285
92
                     "store is probably damaged/corrupt"])
286
93
 
287
 
    @needs_read_lock
288
 
    def path2id(self, path):
289
 
        """Return the id for path in this tree."""
290
 
        return self._inventory.path2id(path)
291
 
 
292
 
    def paths2ids(self, paths, trees=[], require_versioned=True):
293
 
        """Return all the ids that can be reached by walking from paths.
294
 
        
295
 
        Each path is looked up in each this tree and any extras provided in
296
 
        trees, and this is repeated recursively: the children in an extra tree
297
 
        of a directory that has been renamed under a provided path in this tree
298
 
        are all returned, even if none exist until a provided path in this
299
 
        tree, and vice versa.
300
 
 
301
 
        :param paths: An iterable of paths to start converting to ids from.
302
 
            Alternatively, if paths is None, no ids should be calculated and None
303
 
            will be returned. This is offered to make calling the api unconditional
304
 
            for code that *might* take a list of files.
305
 
        :param trees: Additional trees to consider.
306
 
        :param require_versioned: If False, do not raise NotVersionedError if
307
 
            an element of paths is not versioned in this tree and all of trees.
308
 
        """
309
 
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
310
 
 
311
 
    def print_file(self, file_id):
312
 
        """Print file with id `file_id` to stdout."""
313
 
        file_id = osutils.safe_file_id(file_id)
 
94
 
 
95
    def print_file(self, fileid):
 
96
        """Print file with id `fileid` to stdout."""
314
97
        import sys
315
 
        sys.stdout.write(self.get_file_text(file_id))
316
 
 
317
 
    def lock_read(self):
318
 
        pass
319
 
 
320
 
    def revision_tree(self, revision_id):
321
 
        """Obtain a revision tree for the revision revision_id.
322
 
 
323
 
        The intention of this method is to allow access to possibly cached
324
 
        tree data. Implementors of this method should raise NoSuchRevision if
325
 
        the tree is not locally available, even if they could obtain the 
326
 
        tree via a repository or some other means. Callers are responsible 
327
 
        for finding the ultimate source for a revision tree.
328
 
 
329
 
        :param revision_id: The revision_id of the requested tree.
330
 
        :return: A Tree.
331
 
        :raises: NoSuchRevision if the tree cannot be obtained.
332
 
        """
333
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
98
        pumpfile(self.get_file(fileid), sys.stdout)
 
99
        
 
100
        
 
101
    def export(self, dest):        
 
102
        """Export this tree to a new directory.
 
103
 
 
104
        `dest` should not exist, and will be created holding the
 
105
        contents of this tree.
 
106
 
 
107
        TODO: To handle subdirectories we need to create the
 
108
               directories first.
 
109
 
 
110
        :note: If the export fails, the destination directory will be
 
111
               left in a half-assed state.
 
112
        """
 
113
        os.mkdir(dest)
 
114
        mutter('export version %r' % self)
 
115
        inv = self.inventory
 
116
        for dp, ie in inv.iter_entries():
 
117
            kind = ie.kind
 
118
            fullpath = appendpath(dest, dp)
 
119
            if kind == 'directory':
 
120
                os.mkdir(fullpath)
 
121
            elif kind == 'file':
 
122
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
 
123
            else:
 
124
                bailout("don't know how to export {%s} of kind %r" % (fid, kind))
 
125
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
126
 
 
127
 
 
128
 
 
129
class WorkingTree(Tree):
 
130
    """Working copy tree.
 
131
 
 
132
    The inventory is held in the `Branch` working-inventory, and the
 
133
    files are in a directory on disk.
 
134
 
 
135
    It is possible for a `WorkingTree` to have a filename which is
 
136
    not listed in the Inventory and vice versa.
 
137
    """
 
138
    def __init__(self, basedir, inv):
 
139
        self._inventory = inv
 
140
        self.basedir = basedir
 
141
        self.path2id = inv.path2id
 
142
 
 
143
    def __repr__(self):
 
144
        return "<%s of %s>" % (self.__class__.__name__,
 
145
                               self.basedir)
 
146
 
 
147
    def abspath(self, filename):
 
148
        return os.path.join(self.basedir, filename)
 
149
 
 
150
    def has_filename(self, filename):
 
151
        return os.path.exists(self.abspath(filename))
 
152
 
 
153
    def get_file(self, file_id):
 
154
        return self.get_file_byname(self.id2path(file_id))
 
155
 
 
156
    def get_file_byname(self, filename):
 
157
        return file(self.abspath(filename), 'rb')
 
158
 
 
159
    def _get_store_filename(self, file_id):
 
160
        ## XXX: badly named; this isn't in the store at all
 
161
        return self.abspath(self.id2path(file_id))
 
162
 
 
163
    def has_id(self, file_id):
 
164
        # files that have been deleted are excluded
 
165
        if not self.inventory.has_id(file_id):
 
166
            return False
 
167
        return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
 
168
 
 
169
    def get_file_size(self, file_id):
 
170
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
 
171
 
 
172
    def get_file_sha1(self, file_id):
 
173
        f = self.get_file(file_id)
 
174
        return sha_file(f)
 
175
 
 
176
 
 
177
    def file_class(self, filename):
 
178
        if self.path2id(filename):
 
179
            return 'V'
 
180
        elif self.is_ignored(filename):
 
181
            return 'I'
 
182
        else:
 
183
            return '?'
 
184
 
 
185
 
 
186
    def list_files(self):
 
187
        """Recursively list all files as (path, class, kind, id).
 
188
 
 
189
        Lists, but does not descend into unversioned directories.
 
190
 
 
191
        This does not include files that have been deleted in this
 
192
        tree.
 
193
 
 
194
        Skips the control directory.
 
195
        """
 
196
        inv = self.inventory
 
197
 
 
198
        def descend(from_dir_relpath, from_dir_id, dp):
 
199
            ls = os.listdir(dp)
 
200
            ls.sort()
 
201
            for f in ls:
 
202
                ## TODO: If we find a subdirectory with its own .bzr
 
203
                ## directory, then that is a separate tree and we
 
204
                ## should exclude it.
 
205
                if bzrlib.BZRDIR == f:
 
206
                    continue
 
207
 
 
208
                # path within tree
 
209
                fp = appendpath(from_dir_relpath, f)
 
210
 
 
211
                # absolute path
 
212
                fap = appendpath(dp, f)
 
213
                
 
214
                f_ie = inv.get_child(from_dir_id, f)
 
215
                if f_ie:
 
216
                    c = 'V'
 
217
                elif self.is_ignored(fp):
 
218
                    c = 'I'
 
219
                else:
 
220
                    c = '?'
 
221
 
 
222
                fk = file_kind(fap)
 
223
 
 
224
                if f_ie:
 
225
                    if f_ie.kind != fk:
 
226
                        bailout("file %r entered as kind %r id %r, now of kind %r"
 
227
                                % (fap, f_ie.kind, f_ie.file_id, fk))
 
228
 
 
229
                yield fp, c, fk, (f_ie and f_ie.file_id)
 
230
 
 
231
                if fk != 'directory':
 
232
                    continue
 
233
 
 
234
                if c != 'V':
 
235
                    # don't descend unversioned directories
 
236
                    continue
 
237
                
 
238
                for ff in descend(fp, f_ie.file_id, fap):
 
239
                    yield ff
 
240
 
 
241
        for f in descend('', inv.root.file_id, self.basedir):
 
242
            yield f
 
243
            
 
244
 
334
245
 
335
246
    def unknowns(self):
336
 
        """What files are present in this tree and unknown.
337
 
        
338
 
        :return: an iterator over the unknown files.
339
 
        """
340
 
        return iter([])
341
 
 
342
 
    def unlock(self):
343
 
        pass
344
 
 
345
 
    def filter_unversioned_files(self, paths):
346
 
        """Filter out paths that are versioned.
347
 
 
348
 
        :return: set of paths.
349
 
        """
350
 
        # NB: we specifically *don't* call self.has_filename, because for
351
 
        # WorkingTrees that can indicate files that exist on disk but that 
352
 
        # are not versioned.
353
 
        pred = self.inventory.has_filename
354
 
        return set((p for p in paths if not pred(p)))
355
 
 
356
 
    def walkdirs(self, prefix=""):
357
 
        """Walk the contents of this tree from path down.
358
 
 
359
 
        This yields all the data about the contents of a directory at a time.
360
 
        After each directory has been yielded, if the caller has mutated the
361
 
        list to exclude some directories, they are then not descended into.
362
 
        
363
 
        The data yielded is of the form:
364
 
        ((directory-relpath, directory-path-from-root, directory-fileid),
365
 
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
366
 
          versioned_kind), ...]),
367
 
         - directory-relpath is the containing dirs relpath from prefix
368
 
         - directory-path-from-root is the containing dirs path from /
369
 
         - directory-fileid is the id of the directory if it is versioned.
370
 
         - relpath is the relative path within the subtree being walked.
371
 
         - basename is the basename
372
 
         - kind is the kind of the file now. If unknonwn then the file is not
373
 
           present within the tree - but it may be recorded as versioned. See
374
 
           versioned_kind.
375
 
         - lstat is the stat data *if* the file was statted.
376
 
         - path_from_tree_root is the path from the root of the tree.
377
 
         - file_id is the file_id is the entry is versioned.
378
 
         - versioned_kind is the kind of the file as last recorded in the 
379
 
           versioning system. If 'unknown' the file is not versioned.
380
 
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
381
 
 
382
 
        :param prefix: Start walking from prefix within the tree rather than
383
 
        at the root. This allows one to walk a subtree but get paths that are
384
 
        relative to a tree rooted higher up.
385
 
        :return: an iterator over the directory data.
386
 
        """
387
 
        raise NotImplementedError(self.walkdirs)
 
247
        for subp in self.extras():
 
248
            if not self.is_ignored(subp):
 
249
                yield subp
 
250
 
 
251
 
 
252
    def extras(self):
 
253
        """Yield all unknown files in this WorkingTree.
 
254
 
 
255
        If there are any unknown directories then only the directory is
 
256
        returned, not all its children.  But if there are unknown files
 
257
        under a versioned subdirectory, they are returned.
 
258
 
 
259
        Currently returned depth-first, sorted by name within directories.
 
260
        """
 
261
        ## TODO: Work from given directory downwards
 
262
        
 
263
        for path, dir_entry in self.inventory.directories():
 
264
            mutter("search for unknowns in %r" % path)
 
265
            dirabs = self.abspath(path)
 
266
            if not isdir(dirabs):
 
267
                # e.g. directory deleted
 
268
                continue
 
269
 
 
270
            fl = []
 
271
            for subf in os.listdir(dirabs):
 
272
                if (subf != '.bzr'
 
273
                    and (subf not in dir_entry.children)):
 
274
                    fl.append(subf)
 
275
            
 
276
            fl.sort()
 
277
            for subf in fl:
 
278
                subp = appendpath(path, subf)
 
279
                yield subp
 
280
 
 
281
 
 
282
    def ignored_files(self):
 
283
        """Yield list of PATH, IGNORE_PATTERN"""
 
284
        for subp in self.extras():
 
285
            pat = self.is_ignored(subp)
 
286
            if pat != None:
 
287
                yield subp, pat
 
288
 
 
289
 
 
290
    def get_ignore_list(self):
 
291
        """Return list of ignore patterns.
 
292
 
 
293
        Cached in the Tree object after the first call.
 
294
        """
 
295
        if hasattr(self, '_ignorelist'):
 
296
            return self._ignorelist
 
297
 
 
298
        l = bzrlib.DEFAULT_IGNORE[:]
 
299
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
300
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
301
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
302
        self._ignorelist = l
 
303
        return l
 
304
 
 
305
 
 
306
    def is_ignored(self, filename):
 
307
        r"""Check whether the filename matches an ignore pattern.
 
308
 
 
309
        Patterns containing '/' or '\' need to match the whole path;
 
310
        others match against only the last component.
 
311
 
 
312
        If the file is ignored, returns the pattern which caused it to
 
313
        be ignored, otherwise None.  So this can simply be used as a
 
314
        boolean if desired."""
 
315
 
 
316
        # TODO: Use '**' to match directories, and other extended
 
317
        # globbing stuff from cvs/rsync.
 
318
 
 
319
        # XXX: fnmatch is actually not quite what we want: it's only
 
320
        # approximately the same as real Unix fnmatch, and doesn't
 
321
        # treat dotfiles correctly and allows * to match /.
 
322
        # Eventually it should be replaced with something more
 
323
        # accurate.
 
324
        
 
325
        for pat in self.get_ignore_list():
 
326
            if '/' in pat or '\\' in pat:
 
327
                
 
328
                # as a special case, you can put ./ at the start of a
 
329
                # pattern; this is good to match in the top-level
 
330
                # only;
 
331
                
 
332
                if (pat[:2] == './') or (pat[:2] == '.\\'):
 
333
                    newpat = pat[2:]
 
334
                else:
 
335
                    newpat = pat
 
336
                if fnmatch.fnmatchcase(filename, newpat):
 
337
                    return pat
 
338
            else:
 
339
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
340
                    return pat
 
341
        return None
 
342
        
 
343
 
 
344
        
 
345
        
 
346
 
 
347
class RevisionTree(Tree):
 
348
    """Tree viewing a previous revision.
 
349
 
 
350
    File text can be retrieved from the text store.
 
351
 
 
352
    TODO: Some kind of `__repr__` method, but a good one
 
353
           probably means knowing the branch and revision number,
 
354
           or at least passing a description to the constructor.
 
355
    """
 
356
    
 
357
    def __init__(self, store, inv):
 
358
        self._store = store
 
359
        self._inventory = inv
 
360
 
 
361
    def get_file(self, file_id):
 
362
        ie = self._inventory[file_id]
 
363
        f = self._store[ie.text_id]
 
364
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
365
        self._check_retrieved(ie, f)
 
366
        return f
 
367
 
 
368
    def get_file_size(self, file_id):
 
369
        return self._inventory[file_id].text_size
 
370
 
 
371
    def get_file_sha1(self, file_id):
 
372
        ie = self._inventory[file_id]
 
373
        return ie.text_sha1
 
374
 
 
375
    def has_filename(self, filename):
 
376
        return bool(self.inventory.path2id(filename))
 
377
 
 
378
    def list_files(self):
 
379
        # The only files returned by this are those from the version
 
380
        for path, entry in self.inventory.iter_entries():
 
381
            yield path, 'V', entry.kind, entry.file_id
388
382
 
389
383
 
390
384
class EmptyTree(Tree):
391
 
 
392
385
    def __init__(self):
393
 
        self._inventory = Inventory(root_id=None)
394
 
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
395
 
                               ' use repository.revision_tree instead.',
396
 
                               DeprecationWarning, stacklevel=2)
397
 
 
398
 
    def get_parent_ids(self):
399
 
        return []
400
 
 
401
 
    def get_symlink_target(self, file_id):
402
 
        return None
 
386
        self._inventory = Inventory()
403
387
 
404
388
    def has_filename(self, filename):
405
389
        return False
406
390
 
407
 
    def kind(self, file_id):
408
 
        file_id = osutils.safe_file_id(file_id)
409
 
        assert self._inventory[file_id].kind == "directory"
410
 
        return "directory"
411
 
 
412
 
    def list_files(self, include_root=False):
413
 
        return iter([])
 
391
    def list_files(self):
 
392
        if False:  # just to make it a generator
 
393
            yield None
414
394
    
415
 
    def __contains__(self, file_id):
416
 
        file_id = osutils.safe_file_id(file_id)
417
 
        return (file_id in self._inventory)
418
 
 
419
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
420
 
        return None
421
395
 
422
396
 
423
397
######################################################################
484
458
        if old_name != new_name:
485
459
            yield (old_name, new_name)
486
460
            
487
 
 
488
 
def find_ids_across_trees(filenames, trees, require_versioned=True):
489
 
    """Find the ids corresponding to specified filenames.
490
 
    
491
 
    All matches in all trees will be used, and all children of matched
492
 
    directories will be used.
493
 
 
494
 
    :param filenames: The filenames to find file_ids for (if None, returns
495
 
        None)
496
 
    :param trees: The trees to find file_ids within
497
 
    :param require_versioned: if true, all specified filenames must occur in
498
 
    at least one tree.
499
 
    :return: a set of file ids for the specified filenames and their children.
500
 
    """
501
 
    if not filenames:
502
 
        return None
503
 
    specified_path_ids = _find_ids_across_trees(filenames, trees,
504
 
        require_versioned)
505
 
    return _find_children_across_trees(specified_path_ids, trees)
506
 
 
507
 
 
508
 
def _find_ids_across_trees(filenames, trees, require_versioned):
509
 
    """Find the ids corresponding to specified filenames.
510
 
    
511
 
    All matches in all trees will be used, but subdirectories are not scanned.
512
 
 
513
 
    :param filenames: The filenames to find file_ids for
514
 
    :param trees: The trees to find file_ids within
515
 
    :param require_versioned: if true, all specified filenames must occur in
516
 
        at least one tree.
517
 
    :return: a set of (path, file ids) for the specified filenames
518
 
    """
519
 
    not_versioned = []
520
 
    interesting_ids = set()
521
 
    for tree_path in filenames:
522
 
        not_found = True
523
 
        for tree in trees:
524
 
            file_id = tree.path2id(tree_path)
525
 
            if file_id is not None:
526
 
                interesting_ids.add(file_id)
527
 
                not_found = False
528
 
        if not_found:
529
 
            not_versioned.append(tree_path)
530
 
    if len(not_versioned) > 0 and require_versioned:
531
 
        raise errors.PathsNotVersionedError(not_versioned)
532
 
    return interesting_ids
533
 
 
534
 
 
535
 
def _find_children_across_trees(specified_ids, trees):
536
 
    """Return a set including specified ids and their children
537
 
    
538
 
    All matches in all trees will be used.
539
 
 
540
 
    :param trees: The trees to find file_ids within
541
 
    :return: a set containing all specified ids and their children 
542
 
    """
543
 
    interesting_ids = set(specified_ids)
544
 
    pending = interesting_ids
545
 
    # now handle children of interesting ids
546
 
    # we loop so that we handle all children of each id in both trees
547
 
    while len(pending) > 0:
548
 
        new_pending = set()
549
 
        for file_id in pending:
550
 
            for tree in trees:
551
 
                if not tree.has_id(file_id):
552
 
                    continue
553
 
                entry = tree.inventory[file_id]
554
 
                for child in getattr(entry, 'children', {}).itervalues():
555
 
                    if child.file_id not in interesting_ids:
556
 
                        new_pending.add(child.file_id)
557
 
        interesting_ids.update(new_pending)
558
 
        pending = new_pending
559
 
    return interesting_ids
560
 
 
561
 
 
562
 
class InterTree(InterObject):
563
 
    """This class represents operations taking place between two Trees.
564
 
 
565
 
    Its instances have methods like 'compare' and contain references to the
566
 
    source and target trees these operations are to be carried out on.
567
 
 
568
 
    clients of bzrlib should not need to use InterTree directly, rather they
569
 
    should use the convenience methods on Tree such as 'Tree.compare()' which
570
 
    will pass through to InterTree as appropriate.
571
 
    """
572
 
 
573
 
    _optimisers = []
574
 
 
575
 
    @needs_read_lock
576
 
    def compare(self, want_unchanged=False, specific_files=None,
577
 
        extra_trees=None, require_versioned=False, include_root=False,
578
 
        want_unversioned=False):
579
 
        """Return the changes from source to target.
580
 
 
581
 
        :return: A TreeDelta.
582
 
        :param specific_files: An optional list of file paths to restrict the
583
 
            comparison to. When mapping filenames to ids, all matches in all
584
 
            trees (including optional extra_trees) are used, and all children of
585
 
            matched directories are included.
586
 
        :param want_unchanged: An optional boolean requesting the inclusion of
587
 
            unchanged entries in the result.
588
 
        :param extra_trees: An optional list of additional trees to use when
589
 
            mapping the contents of specific_files (paths) to file_ids.
590
 
        :param require_versioned: An optional boolean (defaults to False). When
591
 
            supplied and True all the 'specific_files' must be versioned, or
592
 
            a PathsNotVersionedError will be thrown.
593
 
        :param want_unversioned: Scan for unversioned paths.
594
 
        """
595
 
        # NB: show_status depends on being able to pass in non-versioned files
596
 
        # and report them as unknown
597
 
        trees = (self.source,)
598
 
        if extra_trees is not None:
599
 
            trees = trees + tuple(extra_trees)
600
 
        # target is usually the newer tree:
601
 
        specific_file_ids = self.target.paths2ids(specific_files, trees,
602
 
            require_versioned=require_versioned)
603
 
        if specific_files and not specific_file_ids:
604
 
            # All files are unversioned, so just return an empty delta
605
 
            # _compare_trees would think we want a complete delta
606
 
            result = delta.TreeDelta()
607
 
            fake_entry = InventoryFile('unused', 'unused', 'unused')
608
 
            result.unversioned = [(path, None,
609
 
                self.target._comparison_data(fake_entry, path)[0]) for path in
610
 
                specific_files]
611
 
            return result
612
 
        return delta._compare_trees(self.source, self.target, want_unchanged,
613
 
            specific_files, include_root, extra_trees=extra_trees,
614
 
            want_unversioned=want_unversioned)
615
 
 
616
 
    def _iter_changes(self, include_unchanged=False,
617
 
                      specific_files=None, pb=None, extra_trees=[],
618
 
                      require_versioned=True, want_unversioned=False):
619
 
        """Generate an iterator of changes between trees.
620
 
 
621
 
        A tuple is returned:
622
 
        (file_id, (path_in_source, path_in_target),
623
 
         changed_content, versioned, parent, name, kind,
624
 
         executable)
625
 
 
626
 
        Changed_content is True if the file's content has changed.  This
627
 
        includes changes to its kind, and to a symlink's target.
628
 
 
629
 
        versioned, parent, name, kind, executable are tuples of (from, to).
630
 
        If a file is missing in a tree, its kind is None.
631
 
 
632
 
        Iteration is done in parent-to-child order, relative to the target
633
 
        tree.
634
 
 
635
 
        There is no guarantee that all paths are in sorted order: the
636
 
        requirement to expand the search due to renames may result in children
637
 
        that should be found early being found late in the search, after
638
 
        lexically later results have been returned.
639
 
        :param require_versioned: Raise errors.PathsNotVersionedError if a
640
 
            path in the specific_files list is not versioned in one of
641
 
            source, target or extra_trees.
642
 
        :param want_unversioned: Should unversioned files be returned in the
643
 
            output. An unversioned file is defined as one with (False, False)
644
 
            for the versioned pair.
645
 
        """
646
 
        result = []
647
 
        lookup_trees = [self.source]
648
 
        if extra_trees:
649
 
             lookup_trees.extend(extra_trees)
650
 
        specific_file_ids = self.target.paths2ids(specific_files,
651
 
            lookup_trees, require_versioned=require_versioned)
652
 
        if want_unversioned:
653
 
            all_unversioned = sorted([(p.split('/'), p) for p in self.target.extras()
654
 
                if not specific_files or
655
 
                    osutils.is_inside_any(specific_files, p)])
656
 
            all_unversioned = deque(all_unversioned)
657
 
        else:
658
 
            all_unversioned = deque()
659
 
        to_paths = {}
660
 
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
661
 
            specific_file_ids=specific_file_ids))
662
 
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
663
 
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
664
 
            specific_file_ids=specific_file_ids))
665
 
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
666
 
        entry_count = 0
667
 
        # the unversioned path lookup only occurs on real trees - where there 
668
 
        # can be extras. So the fake_entry is solely used to look up
669
 
        # executable it values when execute is not supported.
670
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
671
 
        for to_path, to_entry in to_entries_by_dir:
672
 
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
673
 
                unversioned_path = all_unversioned.popleft()
674
 
                to_kind, to_executable, to_stat = \
675
 
                    self.target._comparison_data(fake_entry, unversioned_path[1])
676
 
                yield (None, (None, unversioned_path[1]), True, (False, False),
677
 
                    (None, None),
678
 
                    (None, unversioned_path[0][-1]),
679
 
                    (None, to_kind),
680
 
                    (None, to_executable))
681
 
            file_id = to_entry.file_id
682
 
            to_paths[file_id] = to_path
683
 
            entry_count += 1
684
 
            changed_content = False
685
 
            from_path, from_entry = from_data.get(file_id, (None, None))
686
 
            from_versioned = (from_entry is not None)
687
 
            if from_entry is not None:
688
 
                from_versioned = True
689
 
                from_name = from_entry.name
690
 
                from_parent = from_entry.parent_id
691
 
                from_kind, from_executable, from_stat = \
692
 
                    self.source._comparison_data(from_entry, from_path)
693
 
                entry_count += 1
694
 
            else:
695
 
                from_versioned = False
696
 
                from_kind = None
697
 
                from_parent = None
698
 
                from_name = None
699
 
                from_executable = None
700
 
            versioned = (from_versioned, True)
701
 
            to_kind, to_executable, to_stat = \
702
 
                self.target._comparison_data(to_entry, to_path)
703
 
            kind = (from_kind, to_kind)
704
 
            if kind[0] != kind[1]:
705
 
                changed_content = True
706
 
            elif from_kind == 'file':
707
 
                from_size = self.source._file_size(from_entry, from_stat)
708
 
                to_size = self.target._file_size(to_entry, to_stat)
709
 
                if from_size != to_size:
710
 
                    changed_content = True
711
 
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
712
 
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
713
 
                    changed_content = True
714
 
            elif from_kind == 'symlink':
715
 
                if (self.source.get_symlink_target(file_id) !=
716
 
                    self.target.get_symlink_target(file_id)):
717
 
                    changed_content = True
718
 
                elif from_kind == 'tree-reference':
719
 
                    if (self.source.get_reference_revision(file_id, from_path)
720
 
                        != self.target.get_reference_revision(file_id, to_path)):
721
 
                        changed_content = True 
722
 
            parent = (from_parent, to_entry.parent_id)
723
 
            name = (from_name, to_entry.name)
724
 
            executable = (from_executable, to_executable)
725
 
            if pb is not None:
726
 
                pb.update('comparing files', entry_count, num_entries)
727
 
            if (changed_content is not False or versioned[0] != versioned[1]
728
 
                or parent[0] != parent[1] or name[0] != name[1] or 
729
 
                executable[0] != executable[1] or include_unchanged):
730
 
                yield (file_id, (from_path, to_path), changed_content,
731
 
                    versioned, parent, name, kind, executable)
732
 
 
733
 
        while all_unversioned:
734
 
            # yield any trailing unversioned paths
735
 
            unversioned_path = all_unversioned.popleft()
736
 
            to_kind, to_executable, to_stat = \
737
 
                self.target._comparison_data(fake_entry, unversioned_path[1])
738
 
            yield (None, (None, unversioned_path[1]), True, (False, False),
739
 
                (None, None),
740
 
                (None, unversioned_path[0][-1]),
741
 
                (None, to_kind),
742
 
                (None, to_executable))
743
 
 
744
 
        def get_to_path(to_entry):
745
 
            if to_entry.parent_id is None:
746
 
                to_path = '' # the root
747
 
            else:
748
 
                if to_entry.parent_id not in to_paths:
749
 
                    # recurse up
750
 
                    return get_to_path(self.target.inventory[to_entry.parent_id])
751
 
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
752
 
                                           to_entry.name)
753
 
            to_paths[to_entry.file_id] = to_path
754
 
            return to_path
755
 
 
756
 
        for path, from_entry in from_entries_by_dir:
757
 
            file_id = from_entry.file_id
758
 
            if file_id in to_paths:
759
 
                # already returned
760
 
                continue
761
 
            if not file_id in self.target.inventory:
762
 
                # common case - paths we have not emitted are not present in
763
 
                # target.
764
 
                to_path = None
765
 
            else:
766
 
                to_path = get_to_path(self.target.inventory[file_id])
767
 
            entry_count += 1
768
 
            if pb is not None:
769
 
                pb.update('comparing files', entry_count, num_entries)
770
 
            versioned = (True, False)
771
 
            parent = (from_entry.parent_id, None)
772
 
            name = (from_entry.name, None)
773
 
            from_kind, from_executable, stat_value = \
774
 
                self.source._comparison_data(from_entry, path)
775
 
            kind = (from_kind, None)
776
 
            executable = (from_executable, None)
777
 
            changed_content = True
778
 
            # the parent's path is necessarily known at this point.
779
 
            yield(file_id, (path, to_path), changed_content, versioned, parent,
780
 
                  name, kind, executable)
781
 
 
782
 
 
783
 
# This was deprecated before 0.12, but did not have an official warning
784
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
785
 
def RevisionTree(*args, **kwargs):
786
 
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
787
 
 
788
 
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
789
 
    bzr 0.12.
790
 
    """
791
 
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
792
 
    return _RevisionTree(*args, **kwargs)
793
 
 
794