~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

merge dirstate and trunk

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