← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-27 18:41:20 UTC
  • mto: This revision was merged to the branch mainline in revision 6449.
  • Revision ID: jelmer@samba.org-20120127184120-osvbbiwijy58hsah
remove unnecessary code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transform.py
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2006-2011 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
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
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
16
18
 
17
19
import os
18
20
import errno
19
 
from stat import S_ISREG
 
21
from stat import S_ISREG, S_IEXEC
 
22
import time
20
23
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
from bzrlib import (
24
 
    bzrdir,
 
24
from bzrlib import (
 
25
    errors,
 
26
    lazy_import,
 
27
    registry,
 
28
    trace,
 
29
    tree,
 
30
    )
 
31
lazy_import.lazy_import(globals(), """
 
32
from bzrlib import (
 
33
    annotate,
 
34
    bencode,
 
35
    controldir,
 
36
    commit,
 
37
    conflicts,
25
38
    delta,
26
 
    errors,
27
 
    inventory
 
39
    inventory,
 
40
    multiparent,
 
41
    osutils,
 
42
    revision as _mod_revision,
 
43
    ui,
 
44
    urlutils,
28
45
    )
 
46
from bzrlib.i18n import gettext
29
47
""")
30
 
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
31
 
                           ReusingTransform, NotVersionedError, CantMoveRoot,
 
48
from bzrlib.errors import (DuplicateKey, MalformedTransform,
 
49
                           ReusingTransform, CantMoveRoot,
32
50
                           ExistingLimbo, ImmortalLimbo, NoFinalPath,
33
51
                           UnableCreateSymlink)
34
 
from bzrlib.inventory import InventoryEntry
35
 
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
36
 
                            delete_any, has_symlinks)
37
 
from bzrlib.progress import DummyProgress, ProgressPhase
 
52
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
 
53
from bzrlib.osutils import (
 
54
    delete_any,
 
55
    file_kind,
 
56
    has_symlinks,
 
57
    pathjoin,
 
58
    sha_file,
 
59
    splitpath,
 
60
    supports_executable,
 
61
    )
 
62
from bzrlib.progress import ProgressPhase
38
63
from bzrlib.symbol_versioning import (
39
 
        deprecated_function,
40
 
        zero_fifteen,
41
 
        zero_ninety,
42
 
        )
43
 
from bzrlib.trace import mutter, warning
44
 
from bzrlib import tree
45
 
import bzrlib.ui
46
 
import bzrlib.urlutils as urlutils
 
64
    deprecated_function,
 
65
    deprecated_in,
 
66
    deprecated_method,
 
67
    )
47
68
 
48
69
 
49
70
ROOT_PARENT = "root-parent"
50
71
 
51
 
 
52
72
def unique_add(map, key, value):
53
73
    if key in map:
54
74
        raise DuplicateKey(key=key)
55
75
    map[key] = value
56
76
 
57
77
 
 
78
 
58
79
class _TransformResults(object):
59
80
    def __init__(self, modified_paths, rename_count):
60
81
        object.__init__(self)
62
83
        self.rename_count = rename_count
63
84
 
64
85
 
65
 
class TreeTransform(object):
66
 
    """Represent a tree transformation.
67
 
    
68
 
    This object is designed to support incremental generation of the transform,
69
 
    in any order.
70
 
 
71
 
    However, it gives optimum performance when parent directories are created
72
 
    before their contents.  The transform is then able to put child files
73
 
    directly in their parent directory, avoiding later renames.
74
 
    
75
 
    It is easy to produce malformed transforms, but they are generally
76
 
    harmless.  Attempting to apply a malformed transform will cause an
77
 
    exception to be raised before any modifications are made to the tree.  
78
 
 
79
 
    Many kinds of malformed transforms can be corrected with the 
80
 
    resolve_conflicts function.  The remaining ones indicate programming error,
81
 
    such as trying to create a file with no path.
82
 
 
83
 
    Two sets of file creation methods are supplied.  Convenience methods are:
84
 
     * new_file
85
 
     * new_directory
86
 
     * new_symlink
87
 
 
88
 
    These are composed of the low-level methods:
89
 
     * create_path
90
 
     * create_file or create_directory or create_symlink
91
 
     * version_file
92
 
     * set_executability
93
 
 
94
 
    Transform/Transaction ids
95
 
    -------------------------
96
 
    trans_ids are temporary ids assigned to all files involved in a transform.
97
 
    It's possible, even common, that not all files in the Tree have trans_ids.
98
 
 
99
 
    trans_ids are used because filenames and file_ids are not good enough
100
 
    identifiers; filenames change, and not all files have file_ids.  File-ids
101
 
    are also associated with trans-ids, so that moving a file moves its
102
 
    file-id.
103
 
 
104
 
    trans_ids are only valid for the TreeTransform that generated them.
105
 
 
106
 
    Limbo
107
 
    -----
108
 
    Limbo is a temporary directory use to hold new versions of files.
109
 
    Files are added to limbo by create_file, create_directory, create_symlink,
110
 
    and their convenience variants (new_*).  Files may be removed from limbo
111
 
    using cancel_creation.  Files are renamed from limbo into their final
112
 
    location as part of TreeTransform.apply
113
 
 
114
 
    Limbo must be cleaned up, by either calling TreeTransform.apply or
115
 
    calling TreeTransform.finalize.
116
 
 
117
 
    Files are placed into limbo inside their parent directories, where
118
 
    possible.  This reduces subsequent renames, and makes operations involving
119
 
    lots of files faster.  This optimization is only possible if the parent
120
 
    directory is created *before* creating any of its children, so avoid
121
 
    creating children before parents, where possible.
122
 
 
123
 
    Pending-deletion
124
 
    ----------------
125
 
    This temporary directory is used by _FileMover for storing files that are
126
 
    about to be deleted.  In case of rollback, the files will be restored.
127
 
    FileMover does not delete files until it is sure that a rollback will not
128
 
    happen.  
129
 
    """
130
 
    def __init__(self, tree, pb=DummyProgress()):
131
 
        """Note: a tree_write lock is taken on the tree.
132
 
        
133
 
        Use TreeTransform.finalize() to release the lock (can be omitted if
134
 
        TreeTransform.apply() called).
 
86
class TreeTransformBase(object):
 
87
    """The base class for TreeTransform and its kin."""
 
88
 
 
89
    def __init__(self, tree, pb=None,
 
90
                 case_sensitive=True):
 
91
        """Constructor.
 
92
 
 
93
        :param tree: The tree that will be transformed, but not necessarily
 
94
            the output tree.
 
95
        :param pb: ignored
 
96
        :param case_sensitive: If True, the target of the transform is
 
97
            case sensitive, not just case preserving.
135
98
        """
136
99
        object.__init__(self)
137
100
        self._tree = tree
138
 
        self._tree.lock_tree_write()
139
 
        try:
140
 
            control_files = self._tree._control_files
141
 
            self._limbodir = urlutils.local_path_from_url(
142
 
                control_files.controlfilename('limbo'))
143
 
            try:
144
 
                os.mkdir(self._limbodir)
145
 
            except OSError, e:
146
 
                if e.errno == errno.EEXIST:
147
 
                    raise ExistingLimbo(self._limbodir)
148
 
            self._deletiondir = urlutils.local_path_from_url(
149
 
                control_files.controlfilename('pending-deletion'))
150
 
            try:
151
 
                os.mkdir(self._deletiondir)
152
 
            except OSError, e:
153
 
                if e.errno == errno.EEXIST:
154
 
                    raise errors.ExistingPendingDeletion(self._deletiondir)
155
 
 
156
 
        except: 
157
 
            self._tree.unlock()
158
 
            raise
159
 
 
160
 
        # counter used to generate trans-ids (which are locally unique)
161
101
        self._id_number = 0
162
102
        # mapping of trans_id -> new basename
163
103
        self._new_name = {}
165
105
        self._new_parent = {}
166
106
        # mapping of trans_id with new contents -> new file_kind
167
107
        self._new_contents = {}
168
 
        # A mapping of transform ids to their limbo filename
169
 
        self._limbo_files = {}
170
 
        # A mapping of transform ids to a set of the transform ids of children
171
 
        # that their limbo directory has
172
 
        self._limbo_children = {}
173
 
        # Map transform ids to maps of child filename to child transform id
174
 
        self._limbo_children_names = {}
175
 
        # List of transform ids that need to be renamed from limbo into place
176
 
        self._needs_rename = set()
 
108
        # mapping of trans_id => (sha1 of content, stat_value)
 
109
        self._observed_sha1s = {}
177
110
        # Set of trans_ids whose contents will be removed
178
111
        self._removed_contents = set()
179
112
        # Mapping of trans_id -> new execute-bit value
186
119
        self._non_present_ids = {}
187
120
        # Mapping of new file_id -> trans_id
188
121
        self._r_new_id = {}
189
 
        # Set of file_ids that will be removed
 
122
        # Set of trans_ids that will be removed
190
123
        self._removed_id = set()
191
124
        # Mapping of path in old tree -> trans_id
192
125
        self._tree_path_ids = {}
193
126
        # Mapping trans_id -> path in old tree
194
127
        self._tree_id_paths = {}
195
 
        # Cache of realpath results, to speed up canonical_path
196
 
        self._realpaths = {}
197
 
        # Cache of relpath results, to speed up canonical_path
198
 
        self._relpaths = {}
199
128
        # The trans_id that will be used as the tree root
200
 
        self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
201
 
        # Indictor of whether the transform has been applied
202
 
        self.__done = False
 
129
        root_id = tree.get_root_id()
 
130
        if root_id is not None:
 
131
            self._new_root = self.trans_id_tree_file_id(root_id)
 
132
        else:
 
133
            self._new_root = None
 
134
        # Indicator of whether the transform has been applied
 
135
        self._done = False
203
136
        # A progress bar
204
137
        self._pb = pb
 
138
        # Whether the target is case sensitive
 
139
        self._case_sensitive_target = case_sensitive
205
140
        # A counter of how many files have been renamed
206
141
        self.rename_count = 0
207
142
 
 
143
    def __enter__(self):
 
144
        """Support Context Manager API."""
 
145
        return self
 
146
 
 
147
    def __exit__(self, exc_type, exc_val, exc_tb):
 
148
        """Support Context Manager API."""
 
149
        self.finalize()
 
150
 
 
151
    def finalize(self):
 
152
        """Release the working tree lock, if held.
 
153
 
 
154
        This is required if apply has not been invoked, but can be invoked
 
155
        even after apply.
 
156
        """
 
157
        if self._tree is None:
 
158
            return
 
159
        self._tree.unlock()
 
160
        self._tree = None
 
161
 
208
162
    def __get_root(self):
209
163
        return self._new_root
210
164
 
211
165
    root = property(__get_root)
212
166
 
213
 
    def finalize(self):
214
 
        """Release the working tree lock, if held, clean up limbo dir.
215
 
 
216
 
        This is required if apply has not been invoked, but can be invoked
217
 
        even after apply.
218
 
        """
219
 
        if self._tree is None:
220
 
            return
221
 
        try:
222
 
            entries = [(self._limbo_name(t), t, k) for t, k in
223
 
                       self._new_contents.iteritems()]
224
 
            entries.sort(reverse=True)
225
 
            for path, trans_id, kind in entries:
226
 
                if kind == "directory":
227
 
                    os.rmdir(path)
228
 
                else:
229
 
                    os.unlink(path)
230
 
            try:
231
 
                os.rmdir(self._limbodir)
232
 
            except OSError:
233
 
                # We don't especially care *why* the dir is immortal.
234
 
                raise ImmortalLimbo(self._limbodir)
235
 
            try:
236
 
                os.rmdir(self._deletiondir)
237
 
            except OSError:
238
 
                raise errors.ImmortalPendingDeletion(self._deletiondir)
239
 
        finally:
240
 
            self._tree.unlock()
241
 
            self._tree = None
242
 
 
243
167
    def _assign_id(self):
244
168
        """Produce a new tranform id"""
245
169
        new_id = "new-%s" % self._id_number
255
179
 
256
180
    def adjust_path(self, name, parent, trans_id):
257
181
        """Change the path that is assigned to a transaction id."""
 
182
        if parent is None:
 
183
            raise ValueError("Parent trans-id may not be None")
258
184
        if trans_id == self._new_root:
259
185
            raise CantMoveRoot
260
 
        previous_parent = self._new_parent.get(trans_id)
261
 
        previous_name = self._new_name.get(trans_id)
262
186
        self._new_name[trans_id] = name
263
187
        self._new_parent[trans_id] = parent
264
 
        if (trans_id in self._limbo_files and
265
 
            trans_id not in self._needs_rename):
266
 
            self._rename_in_limbo([trans_id])
267
 
            self._limbo_children[previous_parent].remove(trans_id)
268
 
            del self._limbo_children_names[previous_parent][previous_name]
269
 
 
270
 
    def _rename_in_limbo(self, trans_ids):
271
 
        """Fix limbo names so that the right final path is produced.
272
 
 
273
 
        This means we outsmarted ourselves-- we tried to avoid renaming
274
 
        these files later by creating them with their final names in their
275
 
        final parents.  But now the previous name or parent is no longer
276
 
        suitable, so we have to rename them.
277
 
 
278
 
        Even for trans_ids that have no new contents, we must remove their
279
 
        entries from _limbo_files, because they are now stale.
280
 
        """
281
 
        for trans_id in trans_ids:
282
 
            old_path = self._limbo_files.pop(trans_id)
283
 
            if trans_id not in self._new_contents:
284
 
                continue
285
 
            new_path = self._limbo_name(trans_id)
286
 
            os.rename(old_path, new_path)
287
188
 
288
189
    def adjust_root_path(self, name, parent):
289
190
        """Emulate moving the root by moving all children, instead.
290
 
        
 
191
 
291
192
        We do this by undoing the association of root's transaction id with the
292
193
        current tree.  This allows us to create a new directory with that
293
 
        transaction id.  We unversion the root directory and version the 
 
194
        transaction id.  We unversion the root directory and version the
294
195
        physically new directory, and hope someone versions the tree root
295
196
        later.
296
197
        """
299
200
        # force moving all children of root
300
201
        for child_id in self.iter_tree_children(old_root):
301
202
            if child_id != parent:
302
 
                self.adjust_path(self.final_name(child_id), 
 
203
                self.adjust_path(self.final_name(child_id),
303
204
                                 self.final_parent(child_id), child_id)
304
205
            file_id = self.final_file_id(child_id)
305
206
            if file_id is not None:
306
207
                self.unversion_file(child_id)
307
208
            self.version_file(file_id, child_id)
308
 
        
 
209
 
309
210
        # the physical root needs a new transaction id
310
211
        self._tree_path_ids.pop("")
311
212
        self._tree_id_paths.pop(old_root)
317
218
        self.version_file(old_root_file_id, old_root)
318
219
        self.unversion_file(self._new_root)
319
220
 
 
221
    def fixup_new_roots(self):
 
222
        """Reinterpret requests to change the root directory
 
223
 
 
224
        Instead of creating a root directory, or moving an existing directory,
 
225
        all the attributes and children of the new root are applied to the
 
226
        existing root directory.
 
227
 
 
228
        This means that the old root trans-id becomes obsolete, so it is
 
229
        recommended only to invoke this after the root trans-id has become
 
230
        irrelevant.
 
231
 
 
232
        """
 
233
        new_roots = [k for k, v in self._new_parent.iteritems() if v is
 
234
                     ROOT_PARENT]
 
235
        if len(new_roots) < 1:
 
236
            return
 
237
        if len(new_roots) != 1:
 
238
            raise ValueError('A tree cannot have two roots!')
 
239
        if self._new_root is None:
 
240
            self._new_root = new_roots[0]
 
241
            return
 
242
        old_new_root = new_roots[0]
 
243
        # unversion the new root's directory.
 
244
        if self.final_kind(self._new_root) is None:
 
245
            file_id = self.final_file_id(old_new_root)
 
246
        else:
 
247
            file_id = self.final_file_id(self._new_root)
 
248
        if old_new_root in self._new_id:
 
249
            self.cancel_versioning(old_new_root)
 
250
        else:
 
251
            self.unversion_file(old_new_root)
 
252
        # if, at this stage, root still has an old file_id, zap it so we can
 
253
        # stick a new one in.
 
254
        if (self.tree_file_id(self._new_root) is not None and
 
255
            self._new_root not in self._removed_id):
 
256
            self.unversion_file(self._new_root)
 
257
        if file_id is not None:
 
258
            self.version_file(file_id, self._new_root)
 
259
 
 
260
        # Now move children of new root into old root directory.
 
261
        # Ensure all children are registered with the transaction, but don't
 
262
        # use directly-- some tree children have new parents
 
263
        list(self.iter_tree_children(old_new_root))
 
264
        # Move all children of new root into old root directory.
 
265
        for child in self.by_parent().get(old_new_root, []):
 
266
            self.adjust_path(self.final_name(child), self._new_root, child)
 
267
 
 
268
        # Ensure old_new_root has no directory.
 
269
        if old_new_root in self._new_contents:
 
270
            self.cancel_creation(old_new_root)
 
271
        else:
 
272
            self.delete_contents(old_new_root)
 
273
 
 
274
        # prevent deletion of root directory.
 
275
        if self._new_root in self._removed_contents:
 
276
            self.cancel_deletion(self._new_root)
 
277
 
 
278
        # destroy path info for old_new_root.
 
279
        del self._new_parent[old_new_root]
 
280
        del self._new_name[old_new_root]
 
281
 
320
282
    def trans_id_tree_file_id(self, inventory_id):
321
283
        """Determine the transaction id of a working tree file.
322
 
        
 
284
 
323
285
        This reflects only files that already exist, not ones that will be
324
286
        added by transactions.
325
287
        """
326
 
        path = self._tree.inventory.id2path(inventory_id)
 
288
        if inventory_id is None:
 
289
            raise ValueError('None is not a valid file id')
 
290
        path = self._tree.id2path(inventory_id)
327
291
        return self.trans_id_tree_path(path)
328
292
 
329
293
    def trans_id_file_id(self, file_id):
332
296
        a transaction has been unversioned, it is deliberately still returned.
333
297
        (this will likely lead to an unversioned parent conflict.)
334
298
        """
 
299
        if file_id is None:
 
300
            raise ValueError('None is not a valid file id')
335
301
        if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
336
302
            return self._r_new_id[file_id]
337
 
        elif file_id in self._tree.inventory:
338
 
            return self.trans_id_tree_file_id(file_id)
339
 
        elif file_id in self._non_present_ids:
340
 
            return self._non_present_ids[file_id]
341
 
        else:
342
 
            trans_id = self._assign_id()
343
 
            self._non_present_ids[file_id] = trans_id
344
 
            return trans_id
345
 
 
346
 
    def canonical_path(self, path):
347
 
        """Get the canonical tree-relative path"""
348
 
        # don't follow final symlinks
349
 
        abs = self._tree.abspath(path)
350
 
        if abs in self._relpaths:
351
 
            return self._relpaths[abs]
352
 
        dirname, basename = os.path.split(abs)
353
 
        if dirname not in self._realpaths:
354
 
            self._realpaths[dirname] = os.path.realpath(dirname)
355
 
        dirname = self._realpaths[dirname]
356
 
        abs = pathjoin(dirname, basename)
357
 
        if dirname in self._relpaths:
358
 
            relpath = pathjoin(self._relpaths[dirname], basename)
359
 
            relpath = relpath.rstrip('/\\')
360
 
        else:
361
 
            relpath = self._tree.relpath(abs)
362
 
        self._relpaths[abs] = relpath
363
 
        return relpath
 
303
        else:
 
304
            try:
 
305
                self._tree.iter_entries_by_dir([file_id]).next()
 
306
            except StopIteration:
 
307
                if file_id in self._non_present_ids:
 
308
                    return self._non_present_ids[file_id]
 
309
                else:
 
310
                    trans_id = self._assign_id()
 
311
                    self._non_present_ids[file_id] = trans_id
 
312
                    return trans_id
 
313
            else:
 
314
                return self.trans_id_tree_file_id(file_id)
364
315
 
365
316
    def trans_id_tree_path(self, path):
366
317
        """Determine (and maybe set) the transaction ID for a tree path."""
377
328
            return ROOT_PARENT
378
329
        return self.trans_id_tree_path(os.path.dirname(path))
379
330
 
380
 
    def create_file(self, contents, trans_id, mode_id=None):
381
 
        """Schedule creation of a new file.
382
 
 
383
 
        See also new_file.
384
 
        
385
 
        Contents is an iterator of strings, all of which will be written
386
 
        to the target destination.
387
 
 
388
 
        New file takes the permissions of any existing file with that id,
389
 
        unless mode_id is specified.
390
 
        """
391
 
        name = self._limbo_name(trans_id)
392
 
        f = open(name, 'wb')
393
 
        try:
394
 
            try:
395
 
                unique_add(self._new_contents, trans_id, 'file')
396
 
            except:
397
 
                # Clean up the file, it never got registered so
398
 
                # TreeTransform.finalize() won't clean it up.
399
 
                f.close()
400
 
                os.unlink(name)
401
 
                raise
402
 
 
403
 
            f.writelines(contents)
404
 
        finally:
405
 
            f.close()
406
 
        self._set_mode(trans_id, mode_id, S_ISREG)
407
 
 
408
 
    def _set_mode(self, trans_id, mode_id, typefunc):
409
 
        """Set the mode of new file contents.
410
 
        The mode_id is the existing file to get the mode from (often the same
411
 
        as trans_id).  The operation is only performed if there's a mode match
412
 
        according to typefunc.
413
 
        """
414
 
        if mode_id is None:
415
 
            mode_id = trans_id
416
 
        try:
417
 
            old_path = self._tree_id_paths[mode_id]
418
 
        except KeyError:
419
 
            return
420
 
        try:
421
 
            mode = os.stat(self._tree.abspath(old_path)).st_mode
422
 
        except OSError, e:
423
 
            if e.errno == errno.ENOENT:
424
 
                return
425
 
            else:
426
 
                raise
427
 
        if typefunc(mode):
428
 
            os.chmod(self._limbo_name(trans_id), mode)
429
 
 
430
 
    def create_directory(self, trans_id):
431
 
        """Schedule creation of a new directory.
432
 
        
433
 
        See also new_directory.
434
 
        """
435
 
        os.mkdir(self._limbo_name(trans_id))
436
 
        unique_add(self._new_contents, trans_id, 'directory')
437
 
 
438
 
    def create_symlink(self, target, trans_id):
439
 
        """Schedule creation of a new symbolic link.
440
 
 
441
 
        target is a bytestring.
442
 
        See also new_symlink.
443
 
        """
444
 
        if has_symlinks():
445
 
            os.symlink(target, self._limbo_name(trans_id))
446
 
            unique_add(self._new_contents, trans_id, 'symlink')
447
 
        else:
448
 
            try:
449
 
                path = FinalPaths(self).get_path(trans_id)
450
 
            except KeyError:
451
 
                path = None
452
 
            raise UnableCreateSymlink(path=path)
453
 
 
454
 
    def cancel_creation(self, trans_id):
455
 
        """Cancel the creation of new file contents."""
456
 
        del self._new_contents[trans_id]
457
 
        children = self._limbo_children.get(trans_id)
458
 
        # if this is a limbo directory with children, move them before removing
459
 
        # the directory
460
 
        if children is not None:
461
 
            self._rename_in_limbo(children)
462
 
            del self._limbo_children[trans_id]
463
 
            del self._limbo_children_names[trans_id]
464
 
        delete_any(self._limbo_name(trans_id))
465
 
 
466
331
    def delete_contents(self, trans_id):
467
332
        """Schedule the contents of a path entry for deletion"""
468
 
        self.tree_kind(trans_id)
469
 
        self._removed_contents.add(trans_id)
 
333
        kind = self.tree_kind(trans_id)
 
334
        if kind is not None:
 
335
            self._removed_contents.add(trans_id)
470
336
 
471
337
    def cancel_deletion(self, trans_id):
472
338
        """Cancel a scheduled deletion"""
496
362
 
497
363
    def version_file(self, file_id, trans_id):
498
364
        """Schedule a file to become versioned."""
499
 
        assert file_id is not None
 
365
        if file_id is None:
 
366
            raise ValueError()
500
367
        unique_add(self._new_id, trans_id, file_id)
501
368
        unique_add(self._r_new_id, file_id, trans_id)
502
369
 
506
373
        del self._new_id[trans_id]
507
374
        del self._r_new_id[file_id]
508
375
 
509
 
    def new_paths(self):
510
 
        """Determine the paths of all new and changed files"""
 
376
    def new_paths(self, filesystem_only=False):
 
377
        """Determine the paths of all new and changed files.
 
378
 
 
379
        :param filesystem_only: if True, only calculate values for files
 
380
            that require renames or execute bit changes.
 
381
        """
511
382
        new_ids = set()
512
 
        fp = FinalPaths(self)
513
 
        for id_set in (self._new_name, self._new_parent, self._new_contents,
514
 
                       self._new_id, self._new_executability):
 
383
        if filesystem_only:
 
384
            stale_ids = self._needs_rename.difference(self._new_name)
 
385
            stale_ids.difference_update(self._new_parent)
 
386
            stale_ids.difference_update(self._new_contents)
 
387
            stale_ids.difference_update(self._new_id)
 
388
            needs_rename = self._needs_rename.difference(stale_ids)
 
389
            id_sets = (needs_rename, self._new_executability)
 
390
        else:
 
391
            id_sets = (self._new_name, self._new_parent, self._new_contents,
 
392
                       self._new_id, self._new_executability)
 
393
        for id_set in id_sets:
515
394
            new_ids.update(id_set)
516
 
        new_paths = [(fp.get_path(t), t) for t in new_ids]
517
 
        new_paths.sort()
518
 
        return new_paths
519
 
 
520
 
    def tree_kind(self, trans_id):
521
 
        """Determine the file kind in the working tree.
522
 
 
523
 
        Raises NoSuchFile if the file does not exist
 
395
        return sorted(FinalPaths(self).get_paths(new_ids))
 
396
 
 
397
    def _inventory_altered(self):
 
398
        """Determine which trans_ids need new Inventory entries.
 
399
 
 
400
        An new entry is needed when anything that would be reflected by an
 
401
        inventory entry changes, including file name, file_id, parent file_id,
 
402
        file kind, and the execute bit.
 
403
 
 
404
        Some care is taken to return entries with real changes, not cases
 
405
        where the value is deleted and then restored to its original value,
 
406
        but some actually unchanged values may be returned.
 
407
 
 
408
        :returns: A list of (path, trans_id) for all items requiring an
 
409
            inventory change. Ordered by path.
524
410
        """
525
 
        path = self._tree_id_paths.get(trans_id)
526
 
        if path is None:
527
 
            raise NoSuchFile(None)
528
 
        try:
529
 
            return file_kind(self._tree.abspath(path))
530
 
        except OSError, e:
531
 
            if e.errno != errno.ENOENT:
532
 
                raise
533
 
            else:
534
 
                raise NoSuchFile(path)
 
411
        changed_ids = set()
 
412
        # Find entries whose file_ids are new (or changed).
 
413
        new_file_id = set(t for t in self._new_id
 
414
                          if self._new_id[t] != self.tree_file_id(t))
 
415
        for id_set in [self._new_name, self._new_parent, new_file_id,
 
416
                       self._new_executability]:
 
417
            changed_ids.update(id_set)
 
418
        # removing implies a kind change
 
419
        changed_kind = set(self._removed_contents)
 
420
        # so does adding
 
421
        changed_kind.intersection_update(self._new_contents)
 
422
        # Ignore entries that are already known to have changed.
 
423
        changed_kind.difference_update(changed_ids)
 
424
        #  to keep only the truly changed ones
 
425
        changed_kind = (t for t in changed_kind
 
426
                        if self.tree_kind(t) != self.final_kind(t))
 
427
        # all kind changes will alter the inventory
 
428
        changed_ids.update(changed_kind)
 
429
        # To find entries with changed parent_ids, find parents which existed,
 
430
        # but changed file_id.
 
431
        changed_file_id = set(t for t in new_file_id if t in self._removed_id)
 
432
        # Now add all their children to the set.
 
433
        for parent_trans_id in new_file_id:
 
434
            changed_ids.update(self.iter_tree_children(parent_trans_id))
 
435
        return sorted(FinalPaths(self).get_paths(changed_ids))
535
436
 
536
437
    def final_kind(self, trans_id):
537
438
        """Determine the final file kind, after any changes applied.
538
 
        
539
 
        Raises NoSuchFile if the file does not exist/has no contents.
540
 
        (It is conceivable that a path would be created without the
541
 
        corresponding contents insertion command)
 
439
 
 
440
        :return: None if the file does not exist/has no contents.  (It is
 
441
            conceivable that a path would be created without the corresponding
 
442
            contents insertion command)
542
443
        """
543
444
        if trans_id in self._new_contents:
544
445
            return self._new_contents[trans_id]
545
446
        elif trans_id in self._removed_contents:
546
 
            raise NoSuchFile(None)
 
447
            return None
547
448
        else:
548
449
            return self.tree_kind(trans_id)
549
450
 
557
458
        # the file is old; the old id is still valid
558
459
        if self._new_root == trans_id:
559
460
            return self._tree.get_root_id()
560
 
        return self._tree.inventory.path2id(path)
 
461
        return self._tree.path2id(path)
561
462
 
562
463
    def final_file_id(self, trans_id):
563
464
        """Determine the file id after any changes are applied, or None.
564
 
        
 
465
 
565
466
        None indicates that the file will not be versioned after changes are
566
467
        applied.
567
468
        """
568
469
        try:
569
 
            # there is a new id for this file
570
 
            assert self._new_id[trans_id] is not None
571
470
            return self._new_id[trans_id]
572
471
        except KeyError:
573
472
            if trans_id in self._removed_id:
608
507
 
609
508
    def by_parent(self):
610
509
        """Return a map of parent: children for known parents.
611
 
        
 
510
 
612
511
        Only new paths and parents of tree files with assigned ids are used.
613
512
        """
614
513
        by_parent = {}
615
514
        items = list(self._new_parent.iteritems())
616
 
        items.extend((t, self.final_parent(t)) for t in 
 
515
        items.extend((t, self.final_parent(t)) for t in
617
516
                      self._tree_id_paths.keys())
618
517
        for trans_id, parent_id in items:
619
518
            if parent_id not in by_parent:
630
529
 
631
530
    def find_conflicts(self):
632
531
        """Find any violations of inventory or filesystem invariants"""
633
 
        if self.__done is True:
 
532
        if self._done is True:
634
533
            raise ReusingTransform()
635
534
        conflicts = []
636
535
        # ensure all children of all existent parents are known
647
546
        conflicts.extend(self._overwrite_conflicts())
648
547
        return conflicts
649
548
 
 
549
    def _check_malformed(self):
 
550
        conflicts = self.find_conflicts()
 
551
        if len(conflicts) != 0:
 
552
            raise MalformedTransform(conflicts=conflicts)
 
553
 
650
554
    def _add_tree_children(self):
651
555
        """Add all the children of all active parents to the known paths.
652
556
 
654
558
        removed.  This is a necessary first step in detecting conflicts.
655
559
        """
656
560
        parents = self.by_parent().keys()
657
 
        parents.extend([t for t in self._removed_contents if 
 
561
        parents.extend([t for t in self._removed_contents if
658
562
                        self.tree_kind(t) == 'directory'])
659
563
        for trans_id in self._removed_id:
660
564
            file_id = self.tree_file_id(trans_id)
661
 
            if self._tree.inventory[file_id].kind == 'directory':
 
565
            if file_id is not None:
 
566
                if self._tree.stored_kind(file_id) == 'directory':
 
567
                    parents.append(trans_id)
 
568
            elif self.tree_kind(trans_id) == 'directory':
662
569
                parents.append(trans_id)
663
570
 
664
571
        for parent_id in parents:
665
572
            # ensure that all children are registered with the transaction
666
573
            list(self.iter_tree_children(parent_id))
667
574
 
668
 
    def iter_tree_children(self, parent_id):
669
 
        """Iterate through the entry's tree children, if any"""
670
 
        try:
671
 
            path = self._tree_id_paths[parent_id]
672
 
        except KeyError:
673
 
            return
674
 
        try:
675
 
            children = os.listdir(self._tree.abspath(path))
676
 
        except OSError, e:
677
 
            if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
678
 
                raise
679
 
            return
680
 
            
681
 
        for child in children:
682
 
            childpath = joinpath(path, child)
683
 
            if self._tree.is_control_filename(childpath):
684
 
                continue
685
 
            yield self.trans_id_tree_path(childpath)
686
 
 
 
575
    @deprecated_method(deprecated_in((2, 3, 0)))
687
576
    def has_named_child(self, by_parent, parent_id, name):
688
 
        try:
689
 
            children = by_parent[parent_id]
690
 
        except KeyError:
691
 
            children = []
692
 
        for child in children:
 
577
        return self._has_named_child(
 
578
            name, parent_id, known_children=by_parent.get(parent_id, []))
 
579
 
 
580
    def _has_named_child(self, name, parent_id, known_children):
 
581
        """Does a parent already have a name child.
 
582
 
 
583
        :param name: The searched for name.
 
584
 
 
585
        :param parent_id: The parent for which the check is made.
 
586
 
 
587
        :param known_children: The already known children. This should have
 
588
            been recently obtained from `self.by_parent.get(parent_id)`
 
589
            (or will be if None is passed).
 
590
        """
 
591
        if known_children is None:
 
592
            known_children = self.by_parent().get(parent_id, [])
 
593
        for child in known_children:
693
594
            if self.final_name(child) == name:
694
595
                return True
695
 
        try:
696
 
            path = self._tree_id_paths[parent_id]
697
 
        except KeyError:
 
596
        parent_path = self._tree_id_paths.get(parent_id, None)
 
597
        if parent_path is None:
 
598
            # No parent... no children
698
599
            return False
699
 
        childpath = joinpath(path, name)
700
 
        child_id = self._tree_path_ids.get(childpath)
 
600
        child_path = joinpath(parent_path, name)
 
601
        child_id = self._tree_path_ids.get(child_path, None)
701
602
        if child_id is None:
702
 
            return lexists(self._tree.abspath(childpath))
 
603
            # Not known by the tree transform yet, check the filesystem
 
604
            return osutils.lexists(self._tree.abspath(child_path))
703
605
        else:
704
 
            if self.final_parent(child_id) != parent_id:
705
 
                return False
706
 
            if child_id in self._removed_contents:
707
 
                # XXX What about dangling file-ids?
708
 
                return False
709
 
            else:
710
 
                return True
 
606
            raise AssertionError('child_id is missing: %s, %s, %s'
 
607
                                 % (name, parent_id, child_id))
 
608
 
 
609
    def _available_backup_name(self, name, target_id):
 
610
        """Find an available backup name.
 
611
 
 
612
        :param name: The basename of the file.
 
613
 
 
614
        :param target_id: The directory trans_id where the backup should 
 
615
            be placed.
 
616
        """
 
617
        known_children = self.by_parent().get(target_id, [])
 
618
        return osutils.available_backup_name(
 
619
            name,
 
620
            lambda base: self._has_named_child(
 
621
                base, target_id, known_children))
711
622
 
712
623
    def _parent_loops(self):
713
624
        """No entry should be its own ancestor"""
743
654
 
744
655
    def _improper_versioning(self):
745
656
        """Cannot version a file with no contents, or a bad type.
746
 
        
 
657
 
747
658
        However, existing entries with no contents are okay.
748
659
        """
749
660
        conflicts = []
750
661
        for trans_id in self._new_id.iterkeys():
751
 
            try:
752
 
                kind = self.final_kind(trans_id)
753
 
            except NoSuchFile:
 
662
            kind = self.final_kind(trans_id)
 
663
            if kind is None:
754
664
                conflicts.append(('versioning no contents', trans_id))
755
665
                continue
756
 
            if not InventoryEntry.versionable_kind(kind):
 
666
            if not inventory.InventoryEntry.versionable_kind(kind):
757
667
                conflicts.append(('versioning bad kind', trans_id, kind))
758
668
        return conflicts
759
669
 
760
670
    def _executability_conflicts(self):
761
671
        """Check for bad executability changes.
762
 
        
 
672
 
763
673
        Only versioned files may have their executability set, because
764
674
        1. only versioned entries can have executability under windows
765
675
        2. only files can be executable.  (The execute bit on a directory
770
680
            if self.final_file_id(trans_id) is None:
771
681
                conflicts.append(('unversioned executability', trans_id))
772
682
            else:
773
 
                try:
774
 
                    non_file = self.final_kind(trans_id) != "file"
775
 
                except NoSuchFile:
776
 
                    non_file = True
777
 
                if non_file is True:
 
683
                if self.final_kind(trans_id) != "file":
778
684
                    conflicts.append(('non-file executability', trans_id))
779
685
        return conflicts
780
686
 
782
688
        """Check for overwrites (not permitted on Win32)"""
783
689
        conflicts = []
784
690
        for trans_id in self._new_contents:
785
 
            try:
786
 
                self.tree_kind(trans_id)
787
 
            except NoSuchFile:
 
691
            if self.tree_kind(trans_id) is None:
788
692
                continue
789
693
            if trans_id not in self._removed_contents:
790
694
                conflicts.append(('overwrite', trans_id,
797
701
        if (self._new_name, self._new_parent) == ({}, {}):
798
702
            return conflicts
799
703
        for children in by_parent.itervalues():
800
 
            name_ids = [(self.final_name(t), t) for t in children]
801
 
            if not self._tree.case_sensitive:
802
 
                name_ids = [(n.lower(), t) for n, t in name_ids]
 
704
            name_ids = []
 
705
            for child_tid in children:
 
706
                name = self.final_name(child_tid)
 
707
                if name is not None:
 
708
                    # Keep children only if they still exist in the end
 
709
                    if not self._case_sensitive_target:
 
710
                        name = name.lower()
 
711
                    name_ids.append((name, child_tid))
803
712
            name_ids.sort()
804
713
            last_name = None
805
714
            last_trans_id = None
806
715
            for name, trans_id in name_ids:
807
 
                try:
808
 
                    kind = self.final_kind(trans_id)
809
 
                except NoSuchFile:
810
 
                    kind = None
 
716
                kind = self.final_kind(trans_id)
811
717
                file_id = self.final_file_id(trans_id)
812
718
                if kind is None and file_id is None:
813
719
                    continue
823
729
        conflicts = []
824
730
        removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
825
731
                                self._removed_id))
826
 
        active_tree_ids = set((f for f in self._tree.inventory if
827
 
                               f not in removed_tree_ids))
 
732
        all_ids = self._tree.all_file_ids()
 
733
        active_tree_ids = all_ids.difference(removed_tree_ids)
828
734
        for trans_id, file_id in self._new_id.iteritems():
829
735
            if file_id in active_tree_ids:
830
736
                old_trans_id = self.trans_id_tree_file_id(file_id)
832
738
        return conflicts
833
739
 
834
740
    def _parent_type_conflicts(self, by_parent):
835
 
        """parents must have directory 'contents'."""
 
741
        """Children must have a directory parent"""
836
742
        conflicts = []
837
743
        for parent_id, children in by_parent.iteritems():
838
744
            if parent_id is ROOT_PARENT:
839
745
                continue
840
 
            if not self._any_contents(children):
 
746
            no_children = True
 
747
            for child_id in children:
 
748
                if self.final_kind(child_id) is not None:
 
749
                    no_children = False
 
750
                    break
 
751
            if no_children:
841
752
                continue
842
 
            for child in children:
843
 
                try:
844
 
                    self.final_kind(child)
845
 
                except NoSuchFile:
846
 
                    continue
847
 
            try:
848
 
                kind = self.final_kind(parent_id)
849
 
            except NoSuchFile:
850
 
                kind = None
 
753
            # There is at least a child, so we need an existing directory to
 
754
            # contain it.
 
755
            kind = self.final_kind(parent_id)
851
756
            if kind is None:
 
757
                # The directory will be deleted
852
758
                conflicts.append(('missing parent', parent_id))
853
759
            elif kind != "directory":
 
760
                # Meh, we need a *directory* to put something in it
854
761
                conflicts.append(('non-directory parent', parent_id))
855
762
        return conflicts
856
763
 
857
 
    def _any_contents(self, trans_ids):
858
 
        """Return true if any of the trans_ids, will have contents."""
859
 
        for trans_id in trans_ids:
860
 
            try:
861
 
                kind = self.final_kind(trans_id)
862
 
            except NoSuchFile:
863
 
                continue
864
 
            return True
865
 
        return False
866
 
            
867
 
    def apply(self, no_conflicts=False, _mover=None):
868
 
        """Apply all changes to the inventory and filesystem.
869
 
        
870
 
        If filesystem or inventory conflicts are present, MalformedTransform
871
 
        will be thrown.
872
 
 
873
 
        If apply succeeds, finalize is not necessary.
874
 
 
875
 
        :param no_conflicts: if True, the caller guarantees there are no
876
 
            conflicts, so no check is made.
877
 
        :param _mover: Supply an alternate FileMover, for testing
878
 
        """
879
 
        if not no_conflicts:
880
 
            conflicts = self.find_conflicts()
881
 
            if len(conflicts) != 0:
882
 
                raise MalformedTransform(conflicts=conflicts)
883
 
        inv = self._tree.inventory
884
 
        inventory_delta = []
885
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
886
 
        try:
887
 
            if _mover is None:
888
 
                mover = _FileMover()
889
 
            else:
890
 
                mover = _mover
891
 
            try:
892
 
                child_pb.update('Apply phase', 0, 2)
893
 
                self._apply_removals(inv, inventory_delta, mover)
894
 
                child_pb.update('Apply phase', 1, 2)
895
 
                modified_paths = self._apply_insertions(inv, inventory_delta,
896
 
                                                        mover)
897
 
            except:
898
 
                mover.rollback()
899
 
                raise
900
 
            else:
901
 
                mover.apply_deletions()
902
 
        finally:
903
 
            child_pb.finished()
904
 
        self._tree.apply_inventory_delta(inventory_delta)
905
 
        self.__done = True
906
 
        self.finalize()
907
 
        return _TransformResults(modified_paths, self.rename_count)
908
 
 
909
 
    def _limbo_name(self, trans_id):
910
 
        """Generate the limbo name of a file"""
911
 
        limbo_name = self._limbo_files.get(trans_id)
912
 
        if limbo_name is not None:
913
 
            return limbo_name
914
 
        parent = self._new_parent.get(trans_id)
915
 
        # if the parent directory is already in limbo (e.g. when building a
916
 
        # tree), choose a limbo name inside the parent, to reduce further
917
 
        # renames.
918
 
        use_direct_path = False
919
 
        if self._new_contents.get(parent) == 'directory':
920
 
            filename = self._new_name.get(trans_id)
921
 
            if filename is not None:
922
 
                if parent not in self._limbo_children:
923
 
                    self._limbo_children[parent] = set()
924
 
                    self._limbo_children_names[parent] = {}
925
 
                    use_direct_path = True
926
 
                # the direct path can only be used if no other file has
927
 
                # already taken this pathname, i.e. if the name is unused, or
928
 
                # if it is already associated with this trans_id.
929
 
                elif self._tree.case_sensitive:
930
 
                    if (self._limbo_children_names[parent].get(filename)
931
 
                        in (trans_id, None)):
932
 
                        use_direct_path = True
933
 
                else:
934
 
                    for l_filename, l_trans_id in\
935
 
                        self._limbo_children_names[parent].iteritems():
936
 
                        if l_trans_id == trans_id:
937
 
                            continue
938
 
                        if l_filename.lower() == filename.lower():
939
 
                            break
940
 
                    else:
941
 
                        use_direct_path = True
942
 
 
943
 
        if use_direct_path:
944
 
            limbo_name = pathjoin(self._limbo_files[parent], filename)
945
 
            self._limbo_children[parent].add(trans_id)
946
 
            self._limbo_children_names[parent][filename] = trans_id
947
 
        else:
948
 
            limbo_name = pathjoin(self._limbodir, trans_id)
949
 
            self._needs_rename.add(trans_id)
950
 
        self._limbo_files[trans_id] = limbo_name
951
 
        return limbo_name
952
 
 
953
 
    def _apply_removals(self, inv, inventory_delta, mover):
954
 
        """Perform tree operations that remove directory/inventory names.
955
 
        
956
 
        That is, delete files that are to be deleted, and put any files that
957
 
        need renaming into limbo.  This must be done in strict child-to-parent
958
 
        order.
959
 
        """
960
 
        tree_paths = list(self._tree_path_ids.iteritems())
961
 
        tree_paths.sort(reverse=True)
962
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
963
 
        try:
964
 
            for num, data in enumerate(tree_paths):
965
 
                path, trans_id = data
966
 
                child_pb.update('removing file', num, len(tree_paths))
967
 
                full_path = self._tree.abspath(path)
968
 
                if trans_id in self._removed_contents:
969
 
                    mover.pre_delete(full_path, os.path.join(self._deletiondir,
970
 
                                     trans_id))
971
 
                elif trans_id in self._new_name or trans_id in \
972
 
                    self._new_parent:
973
 
                    try:
974
 
                        mover.rename(full_path, self._limbo_name(trans_id))
975
 
                    except OSError, e:
976
 
                        if e.errno != errno.ENOENT:
977
 
                            raise
978
 
                    else:
979
 
                        self.rename_count += 1
980
 
                if trans_id in self._removed_id:
981
 
                    if trans_id == self._new_root:
982
 
                        file_id = self._tree.get_root_id()
983
 
                    else:
984
 
                        file_id = self.tree_file_id(trans_id)
985
 
                    assert file_id is not None
986
 
                    inventory_delta.append((path, None, file_id, None))
987
 
        finally:
988
 
            child_pb.finished()
989
 
 
990
 
    def _apply_insertions(self, inv, inventory_delta, mover):
991
 
        """Perform tree operations that insert directory/inventory names.
992
 
        
993
 
        That is, create any files that need to be created, and restore from
994
 
        limbo any files that needed renaming.  This must be done in strict
995
 
        parent-to-child order.
996
 
        """
997
 
        new_paths = self.new_paths()
998
 
        modified_paths = []
999
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1000
 
        completed_new = []
1001
 
        try:
1002
 
            for num, (path, trans_id) in enumerate(new_paths):
1003
 
                new_entry = None
1004
 
                child_pb.update('adding file', num, len(new_paths))
1005
 
                try:
1006
 
                    kind = self._new_contents[trans_id]
1007
 
                except KeyError:
1008
 
                    kind = contents = None
1009
 
                if trans_id in self._new_contents or \
1010
 
                    self.path_changed(trans_id):
1011
 
                    full_path = self._tree.abspath(path)
1012
 
                    if trans_id in self._needs_rename:
1013
 
                        try:
1014
 
                            mover.rename(self._limbo_name(trans_id), full_path)
1015
 
                        except OSError, e:
1016
 
                            # We may be renaming a dangling inventory id
1017
 
                            if e.errno != errno.ENOENT:
1018
 
                                raise
1019
 
                        else:
1020
 
                            self.rename_count += 1
1021
 
                    if trans_id in self._new_contents:
1022
 
                        modified_paths.append(full_path)
1023
 
                        completed_new.append(trans_id)
1024
 
 
1025
 
                if trans_id in self._new_id:
1026
 
                    if kind is None:
1027
 
                        kind = file_kind(self._tree.abspath(path))
1028
 
                    if trans_id in self._new_reference_revision:
1029
 
                        new_entry = inventory.TreeReference(
1030
 
                            self._new_id[trans_id],
1031
 
                            self._new_name[trans_id], 
1032
 
                            self.final_file_id(self._new_parent[trans_id]),
1033
 
                            None, self._new_reference_revision[trans_id])
1034
 
                    else:
1035
 
                        new_entry = inventory.make_entry(kind,
1036
 
                            self.final_name(trans_id),
1037
 
                            self.final_file_id(self.final_parent(trans_id)),
1038
 
                            self._new_id[trans_id])
1039
 
                else:
1040
 
                    if trans_id in self._new_name or trans_id in\
1041
 
                        self._new_parent or\
1042
 
                        trans_id in self._new_executability:
1043
 
                        file_id = self.final_file_id(trans_id)
1044
 
                        if file_id is not None:
1045
 
                            entry = inv[file_id]
1046
 
                            new_entry = entry.copy()
1047
 
 
1048
 
                    if trans_id in self._new_name or trans_id in\
1049
 
                        self._new_parent:
1050
 
                            if new_entry is not None:
1051
 
                                new_entry.name = self.final_name(trans_id)
1052
 
                                parent = self.final_parent(trans_id)
1053
 
                                parent_id = self.final_file_id(parent)
1054
 
                                new_entry.parent_id = parent_id
1055
 
 
1056
 
                if trans_id in self._new_executability:
1057
 
                    self._set_executability(path, new_entry, trans_id)
1058
 
                if new_entry is not None:
1059
 
                    if new_entry.file_id in inv:
1060
 
                        old_path = inv.id2path(new_entry.file_id)
1061
 
                    else:
1062
 
                        old_path = None
1063
 
                    inventory_delta.append((old_path, path,
1064
 
                                            new_entry.file_id,
1065
 
                                            new_entry))
1066
 
        finally:
1067
 
            child_pb.finished()
1068
 
        for trans_id in completed_new:
1069
 
            del self._new_contents[trans_id]
1070
 
        return modified_paths
1071
 
 
1072
 
    def _set_executability(self, path, entry, trans_id):
 
764
    def _set_executability(self, path, trans_id):
1073
765
        """Set the executability of versioned files """
1074
 
        new_executability = self._new_executability[trans_id]
1075
 
        entry.executable = new_executability
1076
 
        if supports_executable():
 
766
        if self._tree._supports_executable():
 
767
            new_executability = self._new_executability[trans_id]
1077
768
            abspath = self._tree.abspath(path)
1078
769
            current_mode = os.stat(abspath).st_mode
1079
770
            if new_executability:
1087
778
                    to_mode |= 0010 & ~umask
1088
779
            else:
1089
780
                to_mode = current_mode & ~0111
1090
 
            os.chmod(abspath, to_mode)
 
781
            osutils.chmod_if_possible(abspath, to_mode)
1091
782
 
1092
783
    def _new_entry(self, name, parent_id, file_id):
1093
784
        """Helper function to create a new filesystem entry."""
1096
787
            self.version_file(file_id, trans_id)
1097
788
        return trans_id
1098
789
 
1099
 
    def new_file(self, name, parent_id, contents, file_id=None, 
1100
 
                 executable=None):
 
790
    def new_file(self, name, parent_id, contents, file_id=None,
 
791
                 executable=None, sha1=None):
1101
792
        """Convenience method to create files.
1102
 
        
 
793
 
1103
794
        name is the name of the file to create.
1104
795
        parent_id is the transaction id of the parent directory of the file.
1105
796
        contents is an iterator of bytestrings, which will be used to produce
1110
801
        trans_id = self._new_entry(name, parent_id, file_id)
1111
802
        # TODO: rather than scheduling a set_executable call,
1112
803
        # have create_file create the file with the right mode.
1113
 
        self.create_file(contents, trans_id)
 
804
        self.create_file(contents, trans_id, sha1=sha1)
1114
805
        if executable is not None:
1115
806
            self.set_executability(executable, trans_id)
1116
807
        return trans_id
1125
816
        """
1126
817
        trans_id = self._new_entry(name, parent_id, file_id)
1127
818
        self.create_directory(trans_id)
1128
 
        return trans_id 
 
819
        return trans_id
1129
820
 
1130
821
    def new_symlink(self, name, parent_id, target, file_id=None):
1131
822
        """Convenience method to create symbolic link.
1132
 
        
 
823
 
1133
824
        name is the name of the symlink to create.
1134
825
        parent_id is the transaction id of the parent directory of the symlink.
1135
826
        target is a bytestring of the target of the symlink.
1139
830
        self.create_symlink(target, trans_id)
1140
831
        return trans_id
1141
832
 
 
833
    def new_orphan(self, trans_id, parent_id):
 
834
        """Schedule an item to be orphaned.
 
835
 
 
836
        When a directory is about to be removed, its children, if they are not
 
837
        versioned are moved out of the way: they don't have a parent anymore.
 
838
 
 
839
        :param trans_id: The trans_id of the existing item.
 
840
        :param parent_id: The parent trans_id of the item.
 
841
        """
 
842
        raise NotImplementedError(self.new_orphan)
 
843
 
 
844
    def _get_potential_orphans(self, dir_id):
 
845
        """Find the potential orphans in a directory.
 
846
 
 
847
        A directory can't be safely deleted if there are versioned files in it.
 
848
        If all the contained files are unversioned then they can be orphaned.
 
849
 
 
850
        The 'None' return value means that the directory contains at least one
 
851
        versioned file and should not be deleted.
 
852
 
 
853
        :param dir_id: The directory trans id.
 
854
 
 
855
        :return: A list of the orphan trans ids or None if at least one
 
856
             versioned file is present.
 
857
        """
 
858
        orphans = []
 
859
        # Find the potential orphans, stop if one item should be kept
 
860
        for child_tid in self.by_parent()[dir_id]:
 
861
            if child_tid in self._removed_contents:
 
862
                # The child is removed as part of the transform. Since it was
 
863
                # versioned before, it's not an orphan
 
864
                continue
 
865
            elif self.final_file_id(child_tid) is None:
 
866
                # The child is not versioned
 
867
                orphans.append(child_tid)
 
868
            else:
 
869
                # We have a versioned file here, searching for orphans is
 
870
                # meaningless.
 
871
                orphans = None
 
872
                break
 
873
        return orphans
 
874
 
1142
875
    def _affected_ids(self):
1143
876
        """Return the set of transform ids affected by the transform"""
1144
877
        trans_ids = set(self._removed_id)
1174
907
        from_path = self._tree_id_paths.get(from_trans_id)
1175
908
        if from_versioned:
1176
909
            # get data from working tree if versioned
1177
 
            from_entry = self._tree.inventory[file_id]
 
910
            from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1178
911
            from_name = from_entry.name
1179
912
            from_parent = from_entry.parent_id
1180
913
        else:
1203
936
        Return a (name, parent, kind, executable) tuple
1204
937
        """
1205
938
        to_name = self.final_name(to_trans_id)
1206
 
        try:
1207
 
            to_kind = self.final_kind(to_trans_id)
1208
 
        except NoSuchFile:
1209
 
            to_kind = None
 
939
        to_kind = self.final_kind(to_trans_id)
1210
940
        to_parent = self.final_file_id(self.final_parent(to_trans_id))
1211
941
        if to_trans_id in self._new_executability:
1212
942
            to_executable = self._new_executability[to_trans_id]
1216
946
            to_executable = False
1217
947
        return to_name, to_parent, to_kind, to_executable
1218
948
 
1219
 
    def _iter_changes(self):
1220
 
        """Produce output in the same format as Tree._iter_changes.
 
949
    def iter_changes(self):
 
950
        """Produce output in the same format as Tree.iter_changes.
1221
951
 
1222
952
        Will produce nonsensical results if invoked while inventory/filesystem
1223
953
        conflicts (as reported by TreeTransform.find_conflicts()) are present.
1278
1008
                   (from_executable, to_executable)))
1279
1009
        return iter(sorted(results, key=lambda x:x[1]))
1280
1010
 
 
1011
    def get_preview_tree(self):
 
1012
        """Return a tree representing the result of the transform.
 
1013
 
 
1014
        The tree is a snapshot, and altering the TreeTransform will invalidate
 
1015
        it.
 
1016
        """
 
1017
        return _PreviewTree(self)
 
1018
 
 
1019
    def commit(self, branch, message, merge_parents=None, strict=False,
 
1020
               timestamp=None, timezone=None, committer=None, authors=None,
 
1021
               revprops=None, revision_id=None):
 
1022
        """Commit the result of this TreeTransform to a branch.
 
1023
 
 
1024
        :param branch: The branch to commit to.
 
1025
        :param message: The message to attach to the commit.
 
1026
        :param merge_parents: Additional parent revision-ids specified by
 
1027
            pending merges.
 
1028
        :param strict: If True, abort the commit if there are unversioned
 
1029
            files.
 
1030
        :param timestamp: if not None, seconds-since-epoch for the time and
 
1031
            date.  (May be a float.)
 
1032
        :param timezone: Optional timezone for timestamp, as an offset in
 
1033
            seconds.
 
1034
        :param committer: Optional committer in email-id format.
 
1035
            (e.g. "J Random Hacker <jrandom@example.com>")
 
1036
        :param authors: Optional list of authors in email-id format.
 
1037
        :param revprops: Optional dictionary of revision properties.
 
1038
        :param revision_id: Optional revision id.  (Specifying a revision-id
 
1039
            may reduce performance for some non-native formats.)
 
1040
        :return: The revision_id of the revision committed.
 
1041
        """
 
1042
        self._check_malformed()
 
1043
        if strict:
 
1044
            unversioned = set(self._new_contents).difference(set(self._new_id))
 
1045
            for trans_id in unversioned:
 
1046
                if self.final_file_id(trans_id) is None:
 
1047
                    raise errors.StrictCommitFailed()
 
1048
 
 
1049
        revno, last_rev_id = branch.last_revision_info()
 
1050
        if last_rev_id == _mod_revision.NULL_REVISION:
 
1051
            if merge_parents is not None:
 
1052
                raise ValueError('Cannot supply merge parents for first'
 
1053
                                 ' commit.')
 
1054
            parent_ids = []
 
1055
        else:
 
1056
            parent_ids = [last_rev_id]
 
1057
            if merge_parents is not None:
 
1058
                parent_ids.extend(merge_parents)
 
1059
        if self._tree.get_revision_id() != last_rev_id:
 
1060
            raise ValueError('TreeTransform not based on branch basis: %s' %
 
1061
                             self._tree.get_revision_id())
 
1062
        revprops = commit.Commit.update_revprops(revprops, branch, authors)
 
1063
        builder = branch.get_commit_builder(parent_ids,
 
1064
                                            timestamp=timestamp,
 
1065
                                            timezone=timezone,
 
1066
                                            committer=committer,
 
1067
                                            revprops=revprops,
 
1068
                                            revision_id=revision_id)
 
1069
        preview = self.get_preview_tree()
 
1070
        list(builder.record_iter_changes(preview, last_rev_id,
 
1071
                                         self.iter_changes()))
 
1072
        builder.finish_inventory()
 
1073
        revision_id = builder.commit(message)
 
1074
        branch.set_last_revision_info(revno + 1, revision_id)
 
1075
        return revision_id
 
1076
 
 
1077
    def _text_parent(self, trans_id):
 
1078
        file_id = self.tree_file_id(trans_id)
 
1079
        try:
 
1080
            if file_id is None or self._tree.kind(file_id) != 'file':
 
1081
                return None
 
1082
        except errors.NoSuchFile:
 
1083
            return None
 
1084
        return file_id
 
1085
 
 
1086
    def _get_parents_texts(self, trans_id):
 
1087
        """Get texts for compression parents of this file."""
 
1088
        file_id = self._text_parent(trans_id)
 
1089
        if file_id is None:
 
1090
            return ()
 
1091
        return (self._tree.get_file_text(file_id),)
 
1092
 
 
1093
    def _get_parents_lines(self, trans_id):
 
1094
        """Get lines for compression parents of this file."""
 
1095
        file_id = self._text_parent(trans_id)
 
1096
        if file_id is None:
 
1097
            return ()
 
1098
        return (self._tree.get_file_lines(file_id),)
 
1099
 
 
1100
    def serialize(self, serializer):
 
1101
        """Serialize this TreeTransform.
 
1102
 
 
1103
        :param serializer: A Serialiser like pack.ContainerSerializer.
 
1104
        """
 
1105
        new_name = dict((k, v.encode('utf-8')) for k, v in
 
1106
                        self._new_name.items())
 
1107
        new_executability = dict((k, int(v)) for k, v in
 
1108
                                 self._new_executability.items())
 
1109
        tree_path_ids = dict((k.encode('utf-8'), v)
 
1110
                             for k, v in self._tree_path_ids.items())
 
1111
        attribs = {
 
1112
            '_id_number': self._id_number,
 
1113
            '_new_name': new_name,
 
1114
            '_new_parent': self._new_parent,
 
1115
            '_new_executability': new_executability,
 
1116
            '_new_id': self._new_id,
 
1117
            '_tree_path_ids': tree_path_ids,
 
1118
            '_removed_id': list(self._removed_id),
 
1119
            '_removed_contents': list(self._removed_contents),
 
1120
            '_non_present_ids': self._non_present_ids,
 
1121
            }
 
1122
        yield serializer.bytes_record(bencode.bencode(attribs),
 
1123
                                      (('attribs',),))
 
1124
        for trans_id, kind in self._new_contents.items():
 
1125
            if kind == 'file':
 
1126
                lines = osutils.chunks_to_lines(
 
1127
                    self._read_file_chunks(trans_id))
 
1128
                parents = self._get_parents_lines(trans_id)
 
1129
                mpdiff = multiparent.MultiParent.from_lines(lines, parents)
 
1130
                content = ''.join(mpdiff.to_patch())
 
1131
            if kind == 'directory':
 
1132
                content = ''
 
1133
            if kind == 'symlink':
 
1134
                content = self._read_symlink_target(trans_id)
 
1135
            yield serializer.bytes_record(content, ((trans_id, kind),))
 
1136
 
 
1137
    def deserialize(self, records):
 
1138
        """Deserialize a stored TreeTransform.
 
1139
 
 
1140
        :param records: An iterable of (names, content) tuples, as per
 
1141
            pack.ContainerPushParser.
 
1142
        """
 
1143
        names, content = records.next()
 
1144
        attribs = bencode.bdecode(content)
 
1145
        self._id_number = attribs['_id_number']
 
1146
        self._new_name = dict((k, v.decode('utf-8'))
 
1147
                            for k, v in attribs['_new_name'].items())
 
1148
        self._new_parent = attribs['_new_parent']
 
1149
        self._new_executability = dict((k, bool(v)) for k, v in
 
1150
            attribs['_new_executability'].items())
 
1151
        self._new_id = attribs['_new_id']
 
1152
        self._r_new_id = dict((v, k) for k, v in self._new_id.items())
 
1153
        self._tree_path_ids = {}
 
1154
        self._tree_id_paths = {}
 
1155
        for bytepath, trans_id in attribs['_tree_path_ids'].items():
 
1156
            path = bytepath.decode('utf-8')
 
1157
            self._tree_path_ids[path] = trans_id
 
1158
            self._tree_id_paths[trans_id] = path
 
1159
        self._removed_id = set(attribs['_removed_id'])
 
1160
        self._removed_contents = set(attribs['_removed_contents'])
 
1161
        self._non_present_ids = attribs['_non_present_ids']
 
1162
        for ((trans_id, kind),), content in records:
 
1163
            if kind == 'file':
 
1164
                mpdiff = multiparent.MultiParent.from_patch(content)
 
1165
                lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
 
1166
                self.create_file(lines, trans_id)
 
1167
            if kind == 'directory':
 
1168
                self.create_directory(trans_id)
 
1169
            if kind == 'symlink':
 
1170
                self.create_symlink(content.decode('utf-8'), trans_id)
 
1171
 
 
1172
 
 
1173
class DiskTreeTransform(TreeTransformBase):
 
1174
    """Tree transform storing its contents on disk."""
 
1175
 
 
1176
    def __init__(self, tree, limbodir, pb=None,
 
1177
                 case_sensitive=True):
 
1178
        """Constructor.
 
1179
        :param tree: The tree that will be transformed, but not necessarily
 
1180
            the output tree.
 
1181
        :param limbodir: A directory where new files can be stored until
 
1182
            they are installed in their proper places
 
1183
        :param pb: ignored
 
1184
        :param case_sensitive: If True, the target of the transform is
 
1185
            case sensitive, not just case preserving.
 
1186
        """
 
1187
        TreeTransformBase.__init__(self, tree, pb, case_sensitive)
 
1188
        self._limbodir = limbodir
 
1189
        self._deletiondir = None
 
1190
        # A mapping of transform ids to their limbo filename
 
1191
        self._limbo_files = {}
 
1192
        self._possibly_stale_limbo_files = set()
 
1193
        # A mapping of transform ids to a set of the transform ids of children
 
1194
        # that their limbo directory has
 
1195
        self._limbo_children = {}
 
1196
        # Map transform ids to maps of child filename to child transform id
 
1197
        self._limbo_children_names = {}
 
1198
        # List of transform ids that need to be renamed from limbo into place
 
1199
        self._needs_rename = set()
 
1200
        self._creation_mtime = None
 
1201
 
 
1202
    def finalize(self):
 
1203
        """Release the working tree lock, if held, clean up limbo dir.
 
1204
 
 
1205
        This is required if apply has not been invoked, but can be invoked
 
1206
        even after apply.
 
1207
        """
 
1208
        if self._tree is None:
 
1209
            return
 
1210
        try:
 
1211
            limbo_paths = self._limbo_files.values() + list(
 
1212
                self._possibly_stale_limbo_files)
 
1213
            limbo_paths = sorted(limbo_paths, reverse=True)
 
1214
            for path in limbo_paths:
 
1215
                try:
 
1216
                    delete_any(path)
 
1217
                except OSError, e:
 
1218
                    if e.errno != errno.ENOENT:
 
1219
                        raise
 
1220
                    # XXX: warn? perhaps we just got interrupted at an
 
1221
                    # inconvenient moment, but perhaps files are disappearing
 
1222
                    # from under us?
 
1223
            try:
 
1224
                delete_any(self._limbodir)
 
1225
            except OSError:
 
1226
                # We don't especially care *why* the dir is immortal.
 
1227
                raise ImmortalLimbo(self._limbodir)
 
1228
            try:
 
1229
                if self._deletiondir is not None:
 
1230
                    delete_any(self._deletiondir)
 
1231
            except OSError:
 
1232
                raise errors.ImmortalPendingDeletion(self._deletiondir)
 
1233
        finally:
 
1234
            TreeTransformBase.finalize(self)
 
1235
 
 
1236
    def _limbo_supports_executable(self):
 
1237
        """Check if the limbo path supports the executable bit."""
 
1238
        # FIXME: Check actual file system capabilities of limbodir
 
1239
        return osutils.supports_executable()
 
1240
 
 
1241
    def _limbo_name(self, trans_id):
 
1242
        """Generate the limbo name of a file"""
 
1243
        limbo_name = self._limbo_files.get(trans_id)
 
1244
        if limbo_name is None:
 
1245
            limbo_name = self._generate_limbo_path(trans_id)
 
1246
            self._limbo_files[trans_id] = limbo_name
 
1247
        return limbo_name
 
1248
 
 
1249
    def _generate_limbo_path(self, trans_id):
 
1250
        """Generate a limbo path using the trans_id as the relative path.
 
1251
 
 
1252
        This is suitable as a fallback, and when the transform should not be
 
1253
        sensitive to the path encoding of the limbo directory.
 
1254
        """
 
1255
        self._needs_rename.add(trans_id)
 
1256
        return pathjoin(self._limbodir, trans_id)
 
1257
 
 
1258
    def adjust_path(self, name, parent, trans_id):
 
1259
        previous_parent = self._new_parent.get(trans_id)
 
1260
        previous_name = self._new_name.get(trans_id)
 
1261
        TreeTransformBase.adjust_path(self, name, parent, trans_id)
 
1262
        if (trans_id in self._limbo_files and
 
1263
            trans_id not in self._needs_rename):
 
1264
            self._rename_in_limbo([trans_id])
 
1265
            if previous_parent != parent:
 
1266
                self._limbo_children[previous_parent].remove(trans_id)
 
1267
            if previous_parent != parent or previous_name != name:
 
1268
                del self._limbo_children_names[previous_parent][previous_name]
 
1269
 
 
1270
    def _rename_in_limbo(self, trans_ids):
 
1271
        """Fix limbo names so that the right final path is produced.
 
1272
 
 
1273
        This means we outsmarted ourselves-- we tried to avoid renaming
 
1274
        these files later by creating them with their final names in their
 
1275
        final parents.  But now the previous name or parent is no longer
 
1276
        suitable, so we have to rename them.
 
1277
 
 
1278
        Even for trans_ids that have no new contents, we must remove their
 
1279
        entries from _limbo_files, because they are now stale.
 
1280
        """
 
1281
        for trans_id in trans_ids:
 
1282
            old_path = self._limbo_files[trans_id]
 
1283
            self._possibly_stale_limbo_files.add(old_path)
 
1284
            del self._limbo_files[trans_id]
 
1285
            if trans_id not in self._new_contents:
 
1286
                continue
 
1287
            new_path = self._limbo_name(trans_id)
 
1288
            os.rename(old_path, new_path)
 
1289
            self._possibly_stale_limbo_files.remove(old_path)
 
1290
            for descendant in self._limbo_descendants(trans_id):
 
1291
                desc_path = self._limbo_files[descendant]
 
1292
                desc_path = new_path + desc_path[len(old_path):]
 
1293
                self._limbo_files[descendant] = desc_path
 
1294
 
 
1295
    def _limbo_descendants(self, trans_id):
 
1296
        """Return the set of trans_ids whose limbo paths descend from this."""
 
1297
        descendants = set(self._limbo_children.get(trans_id, []))
 
1298
        for descendant in list(descendants):
 
1299
            descendants.update(self._limbo_descendants(descendant))
 
1300
        return descendants
 
1301
 
 
1302
    def create_file(self, contents, trans_id, mode_id=None, sha1=None):
 
1303
        """Schedule creation of a new file.
 
1304
 
 
1305
        :seealso: new_file.
 
1306
 
 
1307
        :param contents: an iterator of strings, all of which will be written
 
1308
            to the target destination.
 
1309
        :param trans_id: TreeTransform handle
 
1310
        :param mode_id: If not None, force the mode of the target file to match
 
1311
            the mode of the object referenced by mode_id.
 
1312
            Otherwise, we will try to preserve mode bits of an existing file.
 
1313
        :param sha1: If the sha1 of this content is already known, pass it in.
 
1314
            We can use it to prevent future sha1 computations.
 
1315
        """
 
1316
        name = self._limbo_name(trans_id)
 
1317
        f = open(name, 'wb')
 
1318
        try:
 
1319
            unique_add(self._new_contents, trans_id, 'file')
 
1320
            f.writelines(contents)
 
1321
        finally:
 
1322
            f.close()
 
1323
        self._set_mtime(name)
 
1324
        self._set_mode(trans_id, mode_id, S_ISREG)
 
1325
        # It is unfortunate we have to use lstat instead of fstat, but we just
 
1326
        # used utime and chmod on the file, so we need the accurate final
 
1327
        # details.
 
1328
        if sha1 is not None:
 
1329
            self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
 
1330
 
 
1331
    def _read_file_chunks(self, trans_id):
 
1332
        cur_file = open(self._limbo_name(trans_id), 'rb')
 
1333
        try:
 
1334
            return cur_file.readlines()
 
1335
        finally:
 
1336
            cur_file.close()
 
1337
 
 
1338
    def _read_symlink_target(self, trans_id):
 
1339
        return os.readlink(self._limbo_name(trans_id))
 
1340
 
 
1341
    def _set_mtime(self, path):
 
1342
        """All files that are created get the same mtime.
 
1343
 
 
1344
        This time is set by the first object to be created.
 
1345
        """
 
1346
        if self._creation_mtime is None:
 
1347
            self._creation_mtime = time.time()
 
1348
        os.utime(path, (self._creation_mtime, self._creation_mtime))
 
1349
 
 
1350
    def create_hardlink(self, path, trans_id):
 
1351
        """Schedule creation of a hard link"""
 
1352
        name = self._limbo_name(trans_id)
 
1353
        try:
 
1354
            os.link(path, name)
 
1355
        except OSError, e:
 
1356
            if e.errno != errno.EPERM:
 
1357
                raise
 
1358
            raise errors.HardLinkNotSupported(path)
 
1359
        try:
 
1360
            unique_add(self._new_contents, trans_id, 'file')
 
1361
        except:
 
1362
            # Clean up the file, it never got registered so
 
1363
            # TreeTransform.finalize() won't clean it up.
 
1364
            os.unlink(name)
 
1365
            raise
 
1366
 
 
1367
    def create_directory(self, trans_id):
 
1368
        """Schedule creation of a new directory.
 
1369
 
 
1370
        See also new_directory.
 
1371
        """
 
1372
        os.mkdir(self._limbo_name(trans_id))
 
1373
        unique_add(self._new_contents, trans_id, 'directory')
 
1374
 
 
1375
    def create_symlink(self, target, trans_id):
 
1376
        """Schedule creation of a new symbolic link.
 
1377
 
 
1378
        target is a bytestring.
 
1379
        See also new_symlink.
 
1380
        """
 
1381
        if has_symlinks():
 
1382
            os.symlink(target, self._limbo_name(trans_id))
 
1383
            unique_add(self._new_contents, trans_id, 'symlink')
 
1384
        else:
 
1385
            try:
 
1386
                path = FinalPaths(self).get_path(trans_id)
 
1387
            except KeyError:
 
1388
                path = None
 
1389
            raise UnableCreateSymlink(path=path)
 
1390
 
 
1391
    def cancel_creation(self, trans_id):
 
1392
        """Cancel the creation of new file contents."""
 
1393
        del self._new_contents[trans_id]
 
1394
        if trans_id in self._observed_sha1s:
 
1395
            del self._observed_sha1s[trans_id]
 
1396
        children = self._limbo_children.get(trans_id)
 
1397
        # if this is a limbo directory with children, move them before removing
 
1398
        # the directory
 
1399
        if children is not None:
 
1400
            self._rename_in_limbo(children)
 
1401
            del self._limbo_children[trans_id]
 
1402
            del self._limbo_children_names[trans_id]
 
1403
        delete_any(self._limbo_name(trans_id))
 
1404
 
 
1405
    def new_orphan(self, trans_id, parent_id):
 
1406
        # FIXME: There is no tree config, so we use the branch one (it's weird
 
1407
        # to define it this way as orphaning can only occur in a working tree,
 
1408
        # but that's all we have (for now). It will find the option in
 
1409
        # locations.conf or bazaar.conf though) -- vila 20100916
 
1410
        conf = self._tree.branch.get_config()
 
1411
        conf_var_name = 'bzr.transform.orphan_policy'
 
1412
        orphan_policy = conf.get_user_option(conf_var_name)
 
1413
        default_policy = orphaning_registry.default_key
 
1414
        if orphan_policy is None:
 
1415
            orphan_policy = default_policy
 
1416
        if orphan_policy not in orphaning_registry:
 
1417
            trace.warning('%s (from %s) is not a known policy, defaulting '
 
1418
                'to %s' % (orphan_policy, conf_var_name, default_policy))
 
1419
            orphan_policy = default_policy
 
1420
        handle_orphan = orphaning_registry.get(orphan_policy)
 
1421
        handle_orphan(self, trans_id, parent_id)
 
1422
 
 
1423
 
 
1424
class OrphaningError(errors.BzrError):
 
1425
 
 
1426
    # Only bugs could lead to such exception being seen by the user
 
1427
    internal_error = True
 
1428
    _fmt = "Error while orphaning %s in %s directory"
 
1429
 
 
1430
    def __init__(self, orphan, parent):
 
1431
        errors.BzrError.__init__(self)
 
1432
        self.orphan = orphan
 
1433
        self.parent = parent
 
1434
 
 
1435
 
 
1436
class OrphaningForbidden(OrphaningError):
 
1437
 
 
1438
    _fmt = "Policy: %s doesn't allow creating orphans."
 
1439
 
 
1440
    def __init__(self, policy):
 
1441
        errors.BzrError.__init__(self)
 
1442
        self.policy = policy
 
1443
 
 
1444
 
 
1445
def move_orphan(tt, orphan_id, parent_id):
 
1446
    """See TreeTransformBase.new_orphan.
 
1447
 
 
1448
    This creates a new orphan in the `bzr-orphans` dir at the root of the
 
1449
    `TreeTransform`.
 
1450
 
 
1451
    :param tt: The TreeTransform orphaning `trans_id`.
 
1452
 
 
1453
    :param orphan_id: The trans id that should be orphaned.
 
1454
 
 
1455
    :param parent_id: The orphan parent trans id.
 
1456
    """
 
1457
    # Add the orphan dir if it doesn't exist
 
1458
    orphan_dir_basename = 'bzr-orphans'
 
1459
    od_id = tt.trans_id_tree_path(orphan_dir_basename)
 
1460
    if tt.final_kind(od_id) is None:
 
1461
        tt.create_directory(od_id)
 
1462
    parent_path = tt._tree_id_paths[parent_id]
 
1463
    # Find a name that doesn't exist yet in the orphan dir
 
1464
    actual_name = tt.final_name(orphan_id)
 
1465
    new_name = tt._available_backup_name(actual_name, od_id)
 
1466
    tt.adjust_path(new_name, od_id, orphan_id)
 
1467
    trace.warning('%s has been orphaned in %s'
 
1468
                  % (joinpath(parent_path, actual_name), orphan_dir_basename))
 
1469
 
 
1470
 
 
1471
def refuse_orphan(tt, orphan_id, parent_id):
 
1472
    """See TreeTransformBase.new_orphan.
 
1473
 
 
1474
    This refuses to create orphan, letting the caller handle the conflict.
 
1475
    """
 
1476
    raise OrphaningForbidden('never')
 
1477
 
 
1478
 
 
1479
orphaning_registry = registry.Registry()
 
1480
orphaning_registry.register(
 
1481
    'conflict', refuse_orphan,
 
1482
    'Leave orphans in place and create a conflict on the directory.')
 
1483
orphaning_registry.register(
 
1484
    'move', move_orphan,
 
1485
    'Move orphans into the bzr-orphans directory.')
 
1486
orphaning_registry._set_default_key('conflict')
 
1487
 
 
1488
 
 
1489
class TreeTransform(DiskTreeTransform):
 
1490
    """Represent a tree transformation.
 
1491
 
 
1492
    This object is designed to support incremental generation of the transform,
 
1493
    in any order.
 
1494
 
 
1495
    However, it gives optimum performance when parent directories are created
 
1496
    before their contents.  The transform is then able to put child files
 
1497
    directly in their parent directory, avoiding later renames.
 
1498
 
 
1499
    It is easy to produce malformed transforms, but they are generally
 
1500
    harmless.  Attempting to apply a malformed transform will cause an
 
1501
    exception to be raised before any modifications are made to the tree.
 
1502
 
 
1503
    Many kinds of malformed transforms can be corrected with the
 
1504
    resolve_conflicts function.  The remaining ones indicate programming error,
 
1505
    such as trying to create a file with no path.
 
1506
 
 
1507
    Two sets of file creation methods are supplied.  Convenience methods are:
 
1508
     * new_file
 
1509
     * new_directory
 
1510
     * new_symlink
 
1511
 
 
1512
    These are composed of the low-level methods:
 
1513
     * create_path
 
1514
     * create_file or create_directory or create_symlink
 
1515
     * version_file
 
1516
     * set_executability
 
1517
 
 
1518
    Transform/Transaction ids
 
1519
    -------------------------
 
1520
    trans_ids are temporary ids assigned to all files involved in a transform.
 
1521
    It's possible, even common, that not all files in the Tree have trans_ids.
 
1522
 
 
1523
    trans_ids are used because filenames and file_ids are not good enough
 
1524
    identifiers; filenames change, and not all files have file_ids.  File-ids
 
1525
    are also associated with trans-ids, so that moving a file moves its
 
1526
    file-id.
 
1527
 
 
1528
    trans_ids are only valid for the TreeTransform that generated them.
 
1529
 
 
1530
    Limbo
 
1531
    -----
 
1532
    Limbo is a temporary directory use to hold new versions of files.
 
1533
    Files are added to limbo by create_file, create_directory, create_symlink,
 
1534
    and their convenience variants (new_*).  Files may be removed from limbo
 
1535
    using cancel_creation.  Files are renamed from limbo into their final
 
1536
    location as part of TreeTransform.apply
 
1537
 
 
1538
    Limbo must be cleaned up, by either calling TreeTransform.apply or
 
1539
    calling TreeTransform.finalize.
 
1540
 
 
1541
    Files are placed into limbo inside their parent directories, where
 
1542
    possible.  This reduces subsequent renames, and makes operations involving
 
1543
    lots of files faster.  This optimization is only possible if the parent
 
1544
    directory is created *before* creating any of its children, so avoid
 
1545
    creating children before parents, where possible.
 
1546
 
 
1547
    Pending-deletion
 
1548
    ----------------
 
1549
    This temporary directory is used by _FileMover for storing files that are
 
1550
    about to be deleted.  In case of rollback, the files will be restored.
 
1551
    FileMover does not delete files until it is sure that a rollback will not
 
1552
    happen.
 
1553
    """
 
1554
    def __init__(self, tree, pb=None):
 
1555
        """Note: a tree_write lock is taken on the tree.
 
1556
 
 
1557
        Use TreeTransform.finalize() to release the lock (can be omitted if
 
1558
        TreeTransform.apply() called).
 
1559
        """
 
1560
        tree.lock_tree_write()
 
1561
 
 
1562
        try:
 
1563
            limbodir = urlutils.local_path_from_url(
 
1564
                tree._transport.abspath('limbo'))
 
1565
            osutils.ensure_empty_directory_exists(
 
1566
                limbodir,
 
1567
                errors.ExistingLimbo)
 
1568
            deletiondir = urlutils.local_path_from_url(
 
1569
                tree._transport.abspath('pending-deletion'))
 
1570
            osutils.ensure_empty_directory_exists(
 
1571
                deletiondir,
 
1572
                errors.ExistingPendingDeletion)
 
1573
        except:
 
1574
            tree.unlock()
 
1575
            raise
 
1576
 
 
1577
        # Cache of realpath results, to speed up canonical_path
 
1578
        self._realpaths = {}
 
1579
        # Cache of relpath results, to speed up canonical_path
 
1580
        self._relpaths = {}
 
1581
        DiskTreeTransform.__init__(self, tree, limbodir, pb,
 
1582
                                   tree.case_sensitive)
 
1583
        self._deletiondir = deletiondir
 
1584
 
 
1585
    def canonical_path(self, path):
 
1586
        """Get the canonical tree-relative path"""
 
1587
        # don't follow final symlinks
 
1588
        abs = self._tree.abspath(path)
 
1589
        if abs in self._relpaths:
 
1590
            return self._relpaths[abs]
 
1591
        dirname, basename = os.path.split(abs)
 
1592
        if dirname not in self._realpaths:
 
1593
            self._realpaths[dirname] = os.path.realpath(dirname)
 
1594
        dirname = self._realpaths[dirname]
 
1595
        abs = pathjoin(dirname, basename)
 
1596
        if dirname in self._relpaths:
 
1597
            relpath = pathjoin(self._relpaths[dirname], basename)
 
1598
            relpath = relpath.rstrip('/\\')
 
1599
        else:
 
1600
            relpath = self._tree.relpath(abs)
 
1601
        self._relpaths[abs] = relpath
 
1602
        return relpath
 
1603
 
 
1604
    def tree_kind(self, trans_id):
 
1605
        """Determine the file kind in the working tree.
 
1606
 
 
1607
        :returns: The file kind or None if the file does not exist
 
1608
        """
 
1609
        path = self._tree_id_paths.get(trans_id)
 
1610
        if path is None:
 
1611
            return None
 
1612
        try:
 
1613
            return file_kind(self._tree.abspath(path))
 
1614
        except errors.NoSuchFile:
 
1615
            return None
 
1616
 
 
1617
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1618
        """Set the mode of new file contents.
 
1619
        The mode_id is the existing file to get the mode from (often the same
 
1620
        as trans_id).  The operation is only performed if there's a mode match
 
1621
        according to typefunc.
 
1622
        """
 
1623
        if mode_id is None:
 
1624
            mode_id = trans_id
 
1625
        try:
 
1626
            old_path = self._tree_id_paths[mode_id]
 
1627
        except KeyError:
 
1628
            return
 
1629
        try:
 
1630
            mode = os.stat(self._tree.abspath(old_path)).st_mode
 
1631
        except OSError, e:
 
1632
            if e.errno in (errno.ENOENT, errno.ENOTDIR):
 
1633
                # Either old_path doesn't exist, or the parent of the
 
1634
                # target is not a directory (but will be one eventually)
 
1635
                # Either way, we know it doesn't exist *right now*
 
1636
                # See also bug #248448
 
1637
                return
 
1638
            else:
 
1639
                raise
 
1640
        if typefunc(mode):
 
1641
            osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
 
1642
 
 
1643
    def iter_tree_children(self, parent_id):
 
1644
        """Iterate through the entry's tree children, if any"""
 
1645
        try:
 
1646
            path = self._tree_id_paths[parent_id]
 
1647
        except KeyError:
 
1648
            return
 
1649
        try:
 
1650
            children = os.listdir(self._tree.abspath(path))
 
1651
        except OSError, e:
 
1652
            if not (osutils._is_error_enotdir(e)
 
1653
                    or e.errno in (errno.ENOENT, errno.ESRCH)):
 
1654
                raise
 
1655
            return
 
1656
 
 
1657
        for child in children:
 
1658
            childpath = joinpath(path, child)
 
1659
            if self._tree.is_control_filename(childpath):
 
1660
                continue
 
1661
            yield self.trans_id_tree_path(childpath)
 
1662
 
 
1663
    def _generate_limbo_path(self, trans_id):
 
1664
        """Generate a limbo path using the final path if possible.
 
1665
 
 
1666
        This optimizes the performance of applying the tree transform by
 
1667
        avoiding renames.  These renames can be avoided only when the parent
 
1668
        directory is already scheduled for creation.
 
1669
 
 
1670
        If the final path cannot be used, falls back to using the trans_id as
 
1671
        the relpath.
 
1672
        """
 
1673
        parent = self._new_parent.get(trans_id)
 
1674
        # if the parent directory is already in limbo (e.g. when building a
 
1675
        # tree), choose a limbo name inside the parent, to reduce further
 
1676
        # renames.
 
1677
        use_direct_path = False
 
1678
        if self._new_contents.get(parent) == 'directory':
 
1679
            filename = self._new_name.get(trans_id)
 
1680
            if filename is not None:
 
1681
                if parent not in self._limbo_children:
 
1682
                    self._limbo_children[parent] = set()
 
1683
                    self._limbo_children_names[parent] = {}
 
1684
                    use_direct_path = True
 
1685
                # the direct path can only be used if no other file has
 
1686
                # already taken this pathname, i.e. if the name is unused, or
 
1687
                # if it is already associated with this trans_id.
 
1688
                elif self._case_sensitive_target:
 
1689
                    if (self._limbo_children_names[parent].get(filename)
 
1690
                        in (trans_id, None)):
 
1691
                        use_direct_path = True
 
1692
                else:
 
1693
                    for l_filename, l_trans_id in\
 
1694
                        self._limbo_children_names[parent].iteritems():
 
1695
                        if l_trans_id == trans_id:
 
1696
                            continue
 
1697
                        if l_filename.lower() == filename.lower():
 
1698
                            break
 
1699
                    else:
 
1700
                        use_direct_path = True
 
1701
 
 
1702
        if not use_direct_path:
 
1703
            return DiskTreeTransform._generate_limbo_path(self, trans_id)
 
1704
 
 
1705
        limbo_name = pathjoin(self._limbo_files[parent], filename)
 
1706
        self._limbo_children[parent].add(trans_id)
 
1707
        self._limbo_children_names[parent][filename] = trans_id
 
1708
        return limbo_name
 
1709
 
 
1710
 
 
1711
    def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
 
1712
        """Apply all changes to the inventory and filesystem.
 
1713
 
 
1714
        If filesystem or inventory conflicts are present, MalformedTransform
 
1715
        will be thrown.
 
1716
 
 
1717
        If apply succeeds, finalize is not necessary.
 
1718
 
 
1719
        :param no_conflicts: if True, the caller guarantees there are no
 
1720
            conflicts, so no check is made.
 
1721
        :param precomputed_delta: An inventory delta to use instead of
 
1722
            calculating one.
 
1723
        :param _mover: Supply an alternate FileMover, for testing
 
1724
        """
 
1725
        if not no_conflicts:
 
1726
            self._check_malformed()
 
1727
        child_pb = ui.ui_factory.nested_progress_bar()
 
1728
        try:
 
1729
            if precomputed_delta is None:
 
1730
                child_pb.update(gettext('Apply phase'), 0, 2)
 
1731
                inventory_delta = self._generate_inventory_delta()
 
1732
                offset = 1
 
1733
            else:
 
1734
                inventory_delta = precomputed_delta
 
1735
                offset = 0
 
1736
            if _mover is None:
 
1737
                mover = _FileMover()
 
1738
            else:
 
1739
                mover = _mover
 
1740
            try:
 
1741
                child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
 
1742
                self._apply_removals(mover)
 
1743
                child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
 
1744
                modified_paths = self._apply_insertions(mover)
 
1745
            except:
 
1746
                mover.rollback()
 
1747
                raise
 
1748
            else:
 
1749
                mover.apply_deletions()
 
1750
        finally:
 
1751
            child_pb.finished()
 
1752
        if self.final_file_id(self.root) is None:
 
1753
            inventory_delta = [e for e in inventory_delta if e[0] != '']
 
1754
        self._tree.apply_inventory_delta(inventory_delta)
 
1755
        self._apply_observed_sha1s()
 
1756
        self._done = True
 
1757
        self.finalize()
 
1758
        return _TransformResults(modified_paths, self.rename_count)
 
1759
 
 
1760
    def _generate_inventory_delta(self):
 
1761
        """Generate an inventory delta for the current transform."""
 
1762
        inventory_delta = []
 
1763
        child_pb = ui.ui_factory.nested_progress_bar()
 
1764
        new_paths = self._inventory_altered()
 
1765
        total_entries = len(new_paths) + len(self._removed_id)
 
1766
        try:
 
1767
            for num, trans_id in enumerate(self._removed_id):
 
1768
                if (num % 10) == 0:
 
1769
                    child_pb.update(gettext('removing file'), num, total_entries)
 
1770
                if trans_id == self._new_root:
 
1771
                    file_id = self._tree.get_root_id()
 
1772
                else:
 
1773
                    file_id = self.tree_file_id(trans_id)
 
1774
                # File-id isn't really being deleted, just moved
 
1775
                if file_id in self._r_new_id:
 
1776
                    continue
 
1777
                path = self._tree_id_paths[trans_id]
 
1778
                inventory_delta.append((path, None, file_id, None))
 
1779
            new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1780
                                     new_paths)
 
1781
            entries = self._tree.iter_entries_by_dir(
 
1782
                new_path_file_ids.values())
 
1783
            old_paths = dict((e.file_id, p) for p, e in entries)
 
1784
            final_kinds = {}
 
1785
            for num, (path, trans_id) in enumerate(new_paths):
 
1786
                if (num % 10) == 0:
 
1787
                    child_pb.update(gettext('adding file'),
 
1788
                                    num + len(self._removed_id), total_entries)
 
1789
                file_id = new_path_file_ids[trans_id]
 
1790
                if file_id is None:
 
1791
                    continue
 
1792
                needs_entry = False
 
1793
                kind = self.final_kind(trans_id)
 
1794
                if kind is None:
 
1795
                    kind = self._tree.stored_kind(file_id)
 
1796
                parent_trans_id = self.final_parent(trans_id)
 
1797
                parent_file_id = new_path_file_ids.get(parent_trans_id)
 
1798
                if parent_file_id is None:
 
1799
                    parent_file_id = self.final_file_id(parent_trans_id)
 
1800
                if trans_id in self._new_reference_revision:
 
1801
                    new_entry = inventory.TreeReference(
 
1802
                        file_id,
 
1803
                        self._new_name[trans_id],
 
1804
                        self.final_file_id(self._new_parent[trans_id]),
 
1805
                        None, self._new_reference_revision[trans_id])
 
1806
                else:
 
1807
                    new_entry = inventory.make_entry(kind,
 
1808
                        self.final_name(trans_id),
 
1809
                        parent_file_id, file_id)
 
1810
                old_path = old_paths.get(new_entry.file_id)
 
1811
                new_executability = self._new_executability.get(trans_id)
 
1812
                if new_executability is not None:
 
1813
                    new_entry.executable = new_executability
 
1814
                inventory_delta.append(
 
1815
                    (old_path, path, new_entry.file_id, new_entry))
 
1816
        finally:
 
1817
            child_pb.finished()
 
1818
        return inventory_delta
 
1819
 
 
1820
    def _apply_removals(self, mover):
 
1821
        """Perform tree operations that remove directory/inventory names.
 
1822
 
 
1823
        That is, delete files that are to be deleted, and put any files that
 
1824
        need renaming into limbo.  This must be done in strict child-to-parent
 
1825
        order.
 
1826
 
 
1827
        If inventory_delta is None, no inventory delta generation is performed.
 
1828
        """
 
1829
        tree_paths = list(self._tree_path_ids.iteritems())
 
1830
        tree_paths.sort(reverse=True)
 
1831
        child_pb = ui.ui_factory.nested_progress_bar()
 
1832
        try:
 
1833
            for num, (path, trans_id) in enumerate(tree_paths):
 
1834
                # do not attempt to move root into a subdirectory of itself.
 
1835
                if path == '':
 
1836
                    continue
 
1837
                child_pb.update(gettext('removing file'), num, len(tree_paths))
 
1838
                full_path = self._tree.abspath(path)
 
1839
                if trans_id in self._removed_contents:
 
1840
                    delete_path = os.path.join(self._deletiondir, trans_id)
 
1841
                    mover.pre_delete(full_path, delete_path)
 
1842
                elif (trans_id in self._new_name
 
1843
                      or trans_id in self._new_parent):
 
1844
                    try:
 
1845
                        mover.rename(full_path, self._limbo_name(trans_id))
 
1846
                    except errors.TransformRenameFailed, e:
 
1847
                        if e.errno != errno.ENOENT:
 
1848
                            raise
 
1849
                    else:
 
1850
                        self.rename_count += 1
 
1851
        finally:
 
1852
            child_pb.finished()
 
1853
 
 
1854
    def _apply_insertions(self, mover):
 
1855
        """Perform tree operations that insert directory/inventory names.
 
1856
 
 
1857
        That is, create any files that need to be created, and restore from
 
1858
        limbo any files that needed renaming.  This must be done in strict
 
1859
        parent-to-child order.
 
1860
 
 
1861
        If inventory_delta is None, no inventory delta is calculated, and
 
1862
        no list of modified paths is returned.
 
1863
        """
 
1864
        new_paths = self.new_paths(filesystem_only=True)
 
1865
        modified_paths = []
 
1866
        new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
 
1867
                                 new_paths)
 
1868
        child_pb = ui.ui_factory.nested_progress_bar()
 
1869
        try:
 
1870
            for num, (path, trans_id) in enumerate(new_paths):
 
1871
                if (num % 10) == 0:
 
1872
                    child_pb.update(gettext('adding file'), num, len(new_paths))
 
1873
                full_path = self._tree.abspath(path)
 
1874
                if trans_id in self._needs_rename:
 
1875
                    try:
 
1876
                        mover.rename(self._limbo_name(trans_id), full_path)
 
1877
                    except errors.TransformRenameFailed, e:
 
1878
                        # We may be renaming a dangling inventory id
 
1879
                        if e.errno != errno.ENOENT:
 
1880
                            raise
 
1881
                    else:
 
1882
                        self.rename_count += 1
 
1883
                    # TODO: if trans_id in self._observed_sha1s, we should
 
1884
                    #       re-stat the final target, since ctime will be
 
1885
                    #       updated by the change.
 
1886
                if (trans_id in self._new_contents or
 
1887
                    self.path_changed(trans_id)):
 
1888
                    if trans_id in self._new_contents:
 
1889
                        modified_paths.append(full_path)
 
1890
                if trans_id in self._new_executability:
 
1891
                    self._set_executability(path, trans_id)
 
1892
                if trans_id in self._observed_sha1s:
 
1893
                    o_sha1, o_st_val = self._observed_sha1s[trans_id]
 
1894
                    st = osutils.lstat(full_path)
 
1895
                    self._observed_sha1s[trans_id] = (o_sha1, st)
 
1896
        finally:
 
1897
            child_pb.finished()
 
1898
        for path, trans_id in new_paths:
 
1899
            # new_paths includes stuff like workingtree conflicts. Only the
 
1900
            # stuff in new_contents actually comes from limbo.
 
1901
            if trans_id in self._limbo_files:
 
1902
                del self._limbo_files[trans_id]
 
1903
        self._new_contents.clear()
 
1904
        return modified_paths
 
1905
 
 
1906
    def _apply_observed_sha1s(self):
 
1907
        """After we have finished renaming everything, update observed sha1s
 
1908
 
 
1909
        This has to be done after self._tree.apply_inventory_delta, otherwise
 
1910
        it doesn't know anything about the files we are updating. Also, we want
 
1911
        to do this as late as possible, so that most entries end up cached.
 
1912
        """
 
1913
        # TODO: this doesn't update the stat information for directories. So
 
1914
        #       the first 'bzr status' will still need to rewrite
 
1915
        #       .bzr/checkout/dirstate. However, we at least don't need to
 
1916
        #       re-read all of the files.
 
1917
        # TODO: If the operation took a while, we could do a time.sleep(3) here
 
1918
        #       to allow the clock to tick over and ensure we won't have any
 
1919
        #       problems. (we could observe start time, and finish time, and if
 
1920
        #       it is less than eg 10% overhead, add a sleep call.)
 
1921
        paths = FinalPaths(self)
 
1922
        for trans_id, observed in self._observed_sha1s.iteritems():
 
1923
            path = paths.get_path(trans_id)
 
1924
            # We could get the file_id, but dirstate prefers to use the path
 
1925
            # anyway, and it is 'cheaper' to determine.
 
1926
            # file_id = self._new_id[trans_id]
 
1927
            self._tree._observed_sha1(None, path, observed)
 
1928
 
 
1929
 
 
1930
class TransformPreview(DiskTreeTransform):
 
1931
    """A TreeTransform for generating preview trees.
 
1932
 
 
1933
    Unlike TreeTransform, this version works when the input tree is a
 
1934
    RevisionTree, rather than a WorkingTree.  As a result, it tends to ignore
 
1935
    unversioned files in the input tree.
 
1936
    """
 
1937
 
 
1938
    def __init__(self, tree, pb=None, case_sensitive=True):
 
1939
        tree.lock_read()
 
1940
        limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
 
1941
        DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
 
1942
 
 
1943
    def canonical_path(self, path):
 
1944
        return path
 
1945
 
 
1946
    def tree_kind(self, trans_id):
 
1947
        path = self._tree_id_paths.get(trans_id)
 
1948
        if path is None:
 
1949
            return None
 
1950
        kind = self._tree.path_content_summary(path)[0]
 
1951
        if kind == 'missing':
 
1952
            kind = None
 
1953
        return kind
 
1954
 
 
1955
    def _set_mode(self, trans_id, mode_id, typefunc):
 
1956
        """Set the mode of new file contents.
 
1957
        The mode_id is the existing file to get the mode from (often the same
 
1958
        as trans_id).  The operation is only performed if there's a mode match
 
1959
        according to typefunc.
 
1960
        """
 
1961
        # is it ok to ignore this?  probably
 
1962
        pass
 
1963
 
 
1964
    def iter_tree_children(self, parent_id):
 
1965
        """Iterate through the entry's tree children, if any"""
 
1966
        try:
 
1967
            path = self._tree_id_paths[parent_id]
 
1968
        except KeyError:
 
1969
            return
 
1970
        file_id = self.tree_file_id(parent_id)
 
1971
        if file_id is None:
 
1972
            return
 
1973
        entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
 
1974
        children = getattr(entry, 'children', {})
 
1975
        for child in children:
 
1976
            childpath = joinpath(path, child)
 
1977
            yield self.trans_id_tree_path(childpath)
 
1978
 
 
1979
    def new_orphan(self, trans_id, parent_id):
 
1980
        raise NotImplementedError(self.new_orphan)
 
1981
 
 
1982
 
 
1983
class _PreviewTree(tree.InventoryTree):
 
1984
    """Partial implementation of Tree to support show_diff_trees"""
 
1985
 
 
1986
    def __init__(self, transform):
 
1987
        self._transform = transform
 
1988
        self._final_paths = FinalPaths(transform)
 
1989
        self.__by_parent = None
 
1990
        self._parent_ids = []
 
1991
        self._all_children_cache = {}
 
1992
        self._path2trans_id_cache = {}
 
1993
        self._final_name_cache = {}
 
1994
        self._iter_changes_cache = dict((c[0], c) for c in
 
1995
                                        self._transform.iter_changes())
 
1996
 
 
1997
    def _content_change(self, file_id):
 
1998
        """Return True if the content of this file changed"""
 
1999
        changes = self._iter_changes_cache.get(file_id)
 
2000
        # changes[2] is true if the file content changed.  See
 
2001
        # InterTree.iter_changes.
 
2002
        return (changes is not None and changes[2])
 
2003
 
 
2004
    def _get_repository(self):
 
2005
        repo = getattr(self._transform._tree, '_repository', None)
 
2006
        if repo is None:
 
2007
            repo = self._transform._tree.branch.repository
 
2008
        return repo
 
2009
 
 
2010
    def _iter_parent_trees(self):
 
2011
        for revision_id in self.get_parent_ids():
 
2012
            try:
 
2013
                yield self.revision_tree(revision_id)
 
2014
            except errors.NoSuchRevisionInTree:
 
2015
                yield self._get_repository().revision_tree(revision_id)
 
2016
 
 
2017
    def _get_file_revision(self, file_id, vf, tree_revision):
 
2018
        parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
 
2019
                       self._iter_parent_trees()]
 
2020
        vf.add_lines((file_id, tree_revision), parent_keys,
 
2021
                     self.get_file_lines(file_id))
 
2022
        repo = self._get_repository()
 
2023
        base_vf = repo.texts
 
2024
        if base_vf not in vf.fallback_versionedfiles:
 
2025
            vf.fallback_versionedfiles.append(base_vf)
 
2026
        return tree_revision
 
2027
 
 
2028
    def _stat_limbo_file(self, file_id=None, trans_id=None):
 
2029
        if trans_id is None:
 
2030
            trans_id = self._transform.trans_id_file_id(file_id)
 
2031
        name = self._transform._limbo_name(trans_id)
 
2032
        return os.lstat(name)
 
2033
 
 
2034
    @property
 
2035
    def _by_parent(self):
 
2036
        if self.__by_parent is None:
 
2037
            self.__by_parent = self._transform.by_parent()
 
2038
        return self.__by_parent
 
2039
 
 
2040
    def _comparison_data(self, entry, path):
 
2041
        kind, size, executable, link_or_sha1 = self.path_content_summary(path)
 
2042
        if kind == 'missing':
 
2043
            kind = None
 
2044
            executable = False
 
2045
        else:
 
2046
            file_id = self._transform.final_file_id(self._path2trans_id(path))
 
2047
            executable = self.is_executable(file_id, path)
 
2048
        return kind, executable, None
 
2049
 
 
2050
    def is_locked(self):
 
2051
        return False
 
2052
 
 
2053
    def lock_read(self):
 
2054
        # Perhaps in theory, this should lock the TreeTransform?
 
2055
        return self
 
2056
 
 
2057
    def unlock(self):
 
2058
        pass
 
2059
 
 
2060
    @property
 
2061
    def inventory(self):
 
2062
        """This Tree does not use inventory as its backing data."""
 
2063
        raise NotImplementedError(_PreviewTree.inventory)
 
2064
 
 
2065
    def get_root_id(self):
 
2066
        return self._transform.final_file_id(self._transform.root)
 
2067
 
 
2068
    def all_file_ids(self):
 
2069
        tree_ids = set(self._transform._tree.all_file_ids())
 
2070
        tree_ids.difference_update(self._transform.tree_file_id(t)
 
2071
                                   for t in self._transform._removed_id)
 
2072
        tree_ids.update(self._transform._new_id.values())
 
2073
        return tree_ids
 
2074
 
 
2075
    def __iter__(self):
 
2076
        return iter(self.all_file_ids())
 
2077
 
 
2078
    def _has_id(self, file_id, fallback_check):
 
2079
        if file_id in self._transform._r_new_id:
 
2080
            return True
 
2081
        elif file_id in set([self._transform.tree_file_id(trans_id) for
 
2082
            trans_id in self._transform._removed_id]):
 
2083
            return False
 
2084
        else:
 
2085
            return fallback_check(file_id)
 
2086
 
 
2087
    def has_id(self, file_id):
 
2088
        return self._has_id(file_id, self._transform._tree.has_id)
 
2089
 
 
2090
    def has_or_had_id(self, file_id):
 
2091
        return self._has_id(file_id, self._transform._tree.has_or_had_id)
 
2092
 
 
2093
    def _path2trans_id(self, path):
 
2094
        # We must not use None here, because that is a valid value to store.
 
2095
        trans_id = self._path2trans_id_cache.get(path, object)
 
2096
        if trans_id is not object:
 
2097
            return trans_id
 
2098
        segments = splitpath(path)
 
2099
        cur_parent = self._transform.root
 
2100
        for cur_segment in segments:
 
2101
            for child in self._all_children(cur_parent):
 
2102
                final_name = self._final_name_cache.get(child)
 
2103
                if final_name is None:
 
2104
                    final_name = self._transform.final_name(child)
 
2105
                    self._final_name_cache[child] = final_name
 
2106
                if final_name == cur_segment:
 
2107
                    cur_parent = child
 
2108
                    break
 
2109
            else:
 
2110
                self._path2trans_id_cache[path] = None
 
2111
                return None
 
2112
        self._path2trans_id_cache[path] = cur_parent
 
2113
        return cur_parent
 
2114
 
 
2115
    def path2id(self, path):
 
2116
        return self._transform.final_file_id(self._path2trans_id(path))
 
2117
 
 
2118
    def id2path(self, file_id):
 
2119
        trans_id = self._transform.trans_id_file_id(file_id)
 
2120
        try:
 
2121
            return self._final_paths._determine_path(trans_id)
 
2122
        except NoFinalPath:
 
2123
            raise errors.NoSuchId(self, file_id)
 
2124
 
 
2125
    def _all_children(self, trans_id):
 
2126
        children = self._all_children_cache.get(trans_id)
 
2127
        if children is not None:
 
2128
            return children
 
2129
        children = set(self._transform.iter_tree_children(trans_id))
 
2130
        # children in the _new_parent set are provided by _by_parent.
 
2131
        children.difference_update(self._transform._new_parent.keys())
 
2132
        children.update(self._by_parent.get(trans_id, []))
 
2133
        self._all_children_cache[trans_id] = children
 
2134
        return children
 
2135
 
 
2136
    def iter_children(self, file_id):
 
2137
        trans_id = self._transform.trans_id_file_id(file_id)
 
2138
        for child_trans_id in self._all_children(trans_id):
 
2139
            yield self._transform.final_file_id(child_trans_id)
 
2140
 
 
2141
    def extras(self):
 
2142
        possible_extras = set(self._transform.trans_id_tree_path(p) for p
 
2143
                              in self._transform._tree.extras())
 
2144
        possible_extras.update(self._transform._new_contents)
 
2145
        possible_extras.update(self._transform._removed_id)
 
2146
        for trans_id in possible_extras:
 
2147
            if self._transform.final_file_id(trans_id) is None:
 
2148
                yield self._final_paths._determine_path(trans_id)
 
2149
 
 
2150
    def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
 
2151
        yield_parents=False):
 
2152
        for trans_id, parent_file_id in ordered_entries:
 
2153
            file_id = self._transform.final_file_id(trans_id)
 
2154
            if file_id is None:
 
2155
                continue
 
2156
            if (specific_file_ids is not None
 
2157
                and file_id not in specific_file_ids):
 
2158
                continue
 
2159
            kind = self._transform.final_kind(trans_id)
 
2160
            if kind is None:
 
2161
                kind = self._transform._tree.stored_kind(file_id)
 
2162
            new_entry = inventory.make_entry(
 
2163
                kind,
 
2164
                self._transform.final_name(trans_id),
 
2165
                parent_file_id, file_id)
 
2166
            yield new_entry, trans_id
 
2167
 
 
2168
    def _list_files_by_dir(self):
 
2169
        todo = [ROOT_PARENT]
 
2170
        ordered_ids = []
 
2171
        while len(todo) > 0:
 
2172
            parent = todo.pop()
 
2173
            parent_file_id = self._transform.final_file_id(parent)
 
2174
            children = list(self._all_children(parent))
 
2175
            paths = dict(zip(children, self._final_paths.get_paths(children)))
 
2176
            children.sort(key=paths.get)
 
2177
            todo.extend(reversed(children))
 
2178
            for trans_id in children:
 
2179
                ordered_ids.append((trans_id, parent_file_id))
 
2180
        return ordered_ids
 
2181
 
 
2182
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
2183
        # This may not be a maximally efficient implementation, but it is
 
2184
        # reasonably straightforward.  An implementation that grafts the
 
2185
        # TreeTransform changes onto the tree's iter_entries_by_dir results
 
2186
        # might be more efficient, but requires tricky inferences about stack
 
2187
        # position.
 
2188
        ordered_ids = self._list_files_by_dir()
 
2189
        for entry, trans_id in self._make_inv_entries(ordered_ids,
 
2190
            specific_file_ids, yield_parents=yield_parents):
 
2191
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
2192
 
 
2193
    def _iter_entries_for_dir(self, dir_path):
 
2194
        """Return path, entry for items in a directory without recursing down."""
 
2195
        dir_file_id = self.path2id(dir_path)
 
2196
        ordered_ids = []
 
2197
        for file_id in self.iter_children(dir_file_id):
 
2198
            trans_id = self._transform.trans_id_file_id(file_id)
 
2199
            ordered_ids.append((trans_id, file_id))
 
2200
        for entry, trans_id in self._make_inv_entries(ordered_ids):
 
2201
            yield unicode(self._final_paths.get_path(trans_id)), entry
 
2202
 
 
2203
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2204
        """See WorkingTree.list_files."""
 
2205
        # XXX This should behave like WorkingTree.list_files, but is really
 
2206
        # more like RevisionTree.list_files.
 
2207
        if recursive:
 
2208
            prefix = None
 
2209
            if from_dir:
 
2210
                prefix = from_dir + '/'
 
2211
            entries = self.iter_entries_by_dir()
 
2212
            for path, entry in entries:
 
2213
                if entry.name == '' and not include_root:
 
2214
                    continue
 
2215
                if prefix:
 
2216
                    if not path.startswith(prefix):
 
2217
                        continue
 
2218
                    path = path[len(prefix):]
 
2219
                yield path, 'V', entry.kind, entry.file_id, entry
 
2220
        else:
 
2221
            if from_dir is None and include_root is True:
 
2222
                root_entry = inventory.make_entry('directory', '',
 
2223
                    ROOT_PARENT, self.get_root_id())
 
2224
                yield '', 'V', 'directory', root_entry.file_id, root_entry
 
2225
            entries = self._iter_entries_for_dir(from_dir or '')
 
2226
            for path, entry in entries:
 
2227
                yield path, 'V', entry.kind, entry.file_id, entry
 
2228
 
 
2229
    def kind(self, file_id):
 
2230
        trans_id = self._transform.trans_id_file_id(file_id)
 
2231
        return self._transform.final_kind(trans_id)
 
2232
 
 
2233
    def stored_kind(self, file_id):
 
2234
        trans_id = self._transform.trans_id_file_id(file_id)
 
2235
        try:
 
2236
            return self._transform._new_contents[trans_id]
 
2237
        except KeyError:
 
2238
            return self._transform._tree.stored_kind(file_id)
 
2239
 
 
2240
    def get_file_mtime(self, file_id, path=None):
 
2241
        """See Tree.get_file_mtime"""
 
2242
        if not self._content_change(file_id):
 
2243
            return self._transform._tree.get_file_mtime(file_id)
 
2244
        return self._stat_limbo_file(file_id).st_mtime
 
2245
 
 
2246
    def _file_size(self, entry, stat_value):
 
2247
        return self.get_file_size(entry.file_id)
 
2248
 
 
2249
    def get_file_size(self, file_id):
 
2250
        """See Tree.get_file_size"""
 
2251
        trans_id = self._transform.trans_id_file_id(file_id)
 
2252
        kind = self._transform.final_kind(trans_id)
 
2253
        if kind != 'file':
 
2254
            return None
 
2255
        if trans_id in self._transform._new_contents:
 
2256
            return self._stat_limbo_file(trans_id=trans_id).st_size
 
2257
        if self.kind(file_id) == 'file':
 
2258
            return self._transform._tree.get_file_size(file_id)
 
2259
        else:
 
2260
            return None
 
2261
 
 
2262
    def get_file_verifier(self, file_id, path=None, stat_value=None):
 
2263
        trans_id = self._transform.trans_id_file_id(file_id)
 
2264
        kind = self._transform._new_contents.get(trans_id)
 
2265
        if kind is None:
 
2266
            return self._transform._tree.get_file_verifier(file_id)
 
2267
        if kind == 'file':
 
2268
            fileobj = self.get_file(file_id)
 
2269
            try:
 
2270
                return ("SHA1", sha_file(fileobj))
 
2271
            finally:
 
2272
                fileobj.close()
 
2273
 
 
2274
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
2275
        trans_id = self._transform.trans_id_file_id(file_id)
 
2276
        kind = self._transform._new_contents.get(trans_id)
 
2277
        if kind is None:
 
2278
            return self._transform._tree.get_file_sha1(file_id)
 
2279
        if kind == 'file':
 
2280
            fileobj = self.get_file(file_id)
 
2281
            try:
 
2282
                return sha_file(fileobj)
 
2283
            finally:
 
2284
                fileobj.close()
 
2285
 
 
2286
    def is_executable(self, file_id, path=None):
 
2287
        if file_id is None:
 
2288
            return False
 
2289
        trans_id = self._transform.trans_id_file_id(file_id)
 
2290
        try:
 
2291
            return self._transform._new_executability[trans_id]
 
2292
        except KeyError:
 
2293
            try:
 
2294
                return self._transform._tree.is_executable(file_id, path)
 
2295
            except OSError, e:
 
2296
                if e.errno == errno.ENOENT:
 
2297
                    return False
 
2298
                raise
 
2299
            except errors.NoSuchId:
 
2300
                return False
 
2301
 
 
2302
    def has_filename(self, path):
 
2303
        trans_id = self._path2trans_id(path)
 
2304
        if trans_id in self._transform._new_contents:
 
2305
            return True
 
2306
        elif trans_id in self._transform._removed_contents:
 
2307
            return False
 
2308
        else:
 
2309
            return self._transform._tree.has_filename(path)
 
2310
 
 
2311
    def path_content_summary(self, path):
 
2312
        trans_id = self._path2trans_id(path)
 
2313
        tt = self._transform
 
2314
        tree_path = tt._tree_id_paths.get(trans_id)
 
2315
        kind = tt._new_contents.get(trans_id)
 
2316
        if kind is None:
 
2317
            if tree_path is None or trans_id in tt._removed_contents:
 
2318
                return 'missing', None, None, None
 
2319
            summary = tt._tree.path_content_summary(tree_path)
 
2320
            kind, size, executable, link_or_sha1 = summary
 
2321
        else:
 
2322
            link_or_sha1 = None
 
2323
            limbo_name = tt._limbo_name(trans_id)
 
2324
            if trans_id in tt._new_reference_revision:
 
2325
                kind = 'tree-reference'
 
2326
            if kind == 'file':
 
2327
                statval = os.lstat(limbo_name)
 
2328
                size = statval.st_size
 
2329
                if not tt._limbo_supports_executable():
 
2330
                    executable = False
 
2331
                else:
 
2332
                    executable = statval.st_mode & S_IEXEC
 
2333
            else:
 
2334
                size = None
 
2335
                executable = None
 
2336
            if kind == 'symlink':
 
2337
                link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
 
2338
        executable = tt._new_executability.get(trans_id, executable)
 
2339
        return kind, size, executable, link_or_sha1
 
2340
 
 
2341
    def iter_changes(self, from_tree, include_unchanged=False,
 
2342
                      specific_files=None, pb=None, extra_trees=None,
 
2343
                      require_versioned=True, want_unversioned=False):
 
2344
        """See InterTree.iter_changes.
 
2345
 
 
2346
        This has a fast path that is only used when the from_tree matches
 
2347
        the transform tree, and no fancy options are supplied.
 
2348
        """
 
2349
        if (from_tree is not self._transform._tree or include_unchanged or
 
2350
            specific_files or want_unversioned):
 
2351
            return tree.InterTree(from_tree, self).iter_changes(
 
2352
                include_unchanged=include_unchanged,
 
2353
                specific_files=specific_files,
 
2354
                pb=pb,
 
2355
                extra_trees=extra_trees,
 
2356
                require_versioned=require_versioned,
 
2357
                want_unversioned=want_unversioned)
 
2358
        if want_unversioned:
 
2359
            raise ValueError('want_unversioned is not supported')
 
2360
        return self._transform.iter_changes()
 
2361
 
 
2362
    def get_file(self, file_id, path=None):
 
2363
        """See Tree.get_file"""
 
2364
        if not self._content_change(file_id):
 
2365
            return self._transform._tree.get_file(file_id, path)
 
2366
        trans_id = self._transform.trans_id_file_id(file_id)
 
2367
        name = self._transform._limbo_name(trans_id)
 
2368
        return open(name, 'rb')
 
2369
 
 
2370
    def get_file_with_stat(self, file_id, path=None):
 
2371
        return self.get_file(file_id, path), None
 
2372
 
 
2373
    def annotate_iter(self, file_id,
 
2374
                      default_revision=_mod_revision.CURRENT_REVISION):
 
2375
        changes = self._iter_changes_cache.get(file_id)
 
2376
        if changes is None:
 
2377
            get_old = True
 
2378
        else:
 
2379
            changed_content, versioned, kind = (changes[2], changes[3],
 
2380
                                                changes[6])
 
2381
            if kind[1] is None:
 
2382
                return None
 
2383
            get_old = (kind[0] == 'file' and versioned[0])
 
2384
        if get_old:
 
2385
            old_annotation = self._transform._tree.annotate_iter(file_id,
 
2386
                default_revision=default_revision)
 
2387
        else:
 
2388
            old_annotation = []
 
2389
        if changes is None:
 
2390
            return old_annotation
 
2391
        if not changed_content:
 
2392
            return old_annotation
 
2393
        # TODO: This is doing something similar to what WT.annotate_iter is
 
2394
        #       doing, however it fails slightly because it doesn't know what
 
2395
        #       the *other* revision_id is, so it doesn't know how to give the
 
2396
        #       other as the origin for some lines, they all get
 
2397
        #       'default_revision'
 
2398
        #       It would be nice to be able to use the new Annotator based
 
2399
        #       approach, as well.
 
2400
        return annotate.reannotate([old_annotation],
 
2401
                                   self.get_file(file_id).readlines(),
 
2402
                                   default_revision)
 
2403
 
 
2404
    def get_symlink_target(self, file_id, path=None):
 
2405
        """See Tree.get_symlink_target"""
 
2406
        if not self._content_change(file_id):
 
2407
            return self._transform._tree.get_symlink_target(file_id)
 
2408
        trans_id = self._transform.trans_id_file_id(file_id)
 
2409
        name = self._transform._limbo_name(trans_id)
 
2410
        return osutils.readlink(name)
 
2411
 
 
2412
    def walkdirs(self, prefix=''):
 
2413
        pending = [self._transform.root]
 
2414
        while len(pending) > 0:
 
2415
            parent_id = pending.pop()
 
2416
            children = []
 
2417
            subdirs = []
 
2418
            prefix = prefix.rstrip('/')
 
2419
            parent_path = self._final_paths.get_path(parent_id)
 
2420
            parent_file_id = self._transform.final_file_id(parent_id)
 
2421
            for child_id in self._all_children(parent_id):
 
2422
                path_from_root = self._final_paths.get_path(child_id)
 
2423
                basename = self._transform.final_name(child_id)
 
2424
                file_id = self._transform.final_file_id(child_id)
 
2425
                kind  = self._transform.final_kind(child_id)
 
2426
                if kind is not None:
 
2427
                    versioned_kind = kind
 
2428
                else:
 
2429
                    kind = 'unknown'
 
2430
                    versioned_kind = self._transform._tree.stored_kind(file_id)
 
2431
                if versioned_kind == 'directory':
 
2432
                    subdirs.append(child_id)
 
2433
                children.append((path_from_root, basename, kind, None,
 
2434
                                 file_id, versioned_kind))
 
2435
            children.sort()
 
2436
            if parent_path.startswith(prefix):
 
2437
                yield (parent_path, parent_file_id), children
 
2438
            pending.extend(sorted(subdirs, key=self._final_paths.get_path,
 
2439
                                  reverse=True))
 
2440
 
 
2441
    def get_parent_ids(self):
 
2442
        return self._parent_ids
 
2443
 
 
2444
    def set_parent_ids(self, parent_ids):
 
2445
        self._parent_ids = parent_ids
 
2446
 
 
2447
    def get_revision_tree(self, revision_id):
 
2448
        return self._transform._tree.get_revision_tree(revision_id)
 
2449
 
1281
2450
 
1282
2451
def joinpath(parent, child):
1283
2452
    """Join tree-relative paths, handling the tree root specially"""
1299
2468
        self.transform = transform
1300
2469
 
1301
2470
    def _determine_path(self, trans_id):
1302
 
        if trans_id == self.transform.root:
 
2471
        if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
1303
2472
            return ""
1304
2473
        name = self.transform.final_name(trans_id)
1305
2474
        parent_id = self.transform.final_parent(trans_id)
1314
2483
            self._known_paths[trans_id] = self._determine_path(trans_id)
1315
2484
        return self._known_paths[trans_id]
1316
2485
 
 
2486
    def get_paths(self, trans_ids):
 
2487
        return [(self.get_path(t), t) for t in trans_ids]
 
2488
 
 
2489
 
1317
2490
 
1318
2491
def topology_sorted_ids(tree):
1319
2492
    """Determine the topological order of the ids in a tree"""
1322
2495
    return file_ids
1323
2496
 
1324
2497
 
1325
 
def build_tree(tree, wt, accelerator_tree=None):
 
2498
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
 
2499
               delta_from_tree=False):
1326
2500
    """Create working tree for a branch, using a TreeTransform.
1327
 
    
 
2501
 
1328
2502
    This function should be used on empty trees, having a tree root at most.
1329
2503
    (see merge and revert functionality for working with existing trees)
1330
2504
 
1331
2505
    Existing files are handled like so:
1332
 
    
 
2506
 
1333
2507
    - Existing bzrdirs take precedence over creating new items.  They are
1334
2508
      created as '%s.diverted' % name.
1335
2509
    - Otherwise, if the content on disk matches the content we are building,
1341
2515
    :param accelerator_tree: A tree which can be used for retrieving file
1342
2516
        contents more quickly than tree itself, i.e. a workingtree.  tree
1343
2517
        will be used for cases where accelerator_tree's content is different.
 
2518
    :param hardlink: If true, hard-link files to accelerator_tree, where
 
2519
        possible.  accelerator_tree must implement abspath, i.e. be a
 
2520
        working tree.
 
2521
    :param delta_from_tree: If true, build_tree may use the input Tree to
 
2522
        generate the inventory delta.
1344
2523
    """
1345
2524
    wt.lock_tree_write()
1346
2525
    try:
1349
2528
            if accelerator_tree is not None:
1350
2529
                accelerator_tree.lock_read()
1351
2530
            try:
1352
 
                return _build_tree(tree, wt, accelerator_tree)
 
2531
                return _build_tree(tree, wt, accelerator_tree, hardlink,
 
2532
                                   delta_from_tree)
1353
2533
            finally:
1354
2534
                if accelerator_tree is not None:
1355
2535
                    accelerator_tree.unlock()
1359
2539
        wt.unlock()
1360
2540
 
1361
2541
 
1362
 
def _build_tree(tree, wt, accelerator_tree):
 
2542
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
1363
2543
    """See build_tree."""
1364
 
    if len(wt.inventory) > 1:  # more than just a root
1365
 
        raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
 
2544
    for num, _unused in enumerate(wt.all_file_ids()):
 
2545
        if num > 0:  # more than just a root
 
2546
            raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1366
2547
    file_trans_id = {}
1367
 
    top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2548
    top_pb = ui.ui_factory.nested_progress_bar()
1368
2549
    pp = ProgressPhase("Build phase", 2, top_pb)
1369
 
    if tree.inventory.root is not None:
 
2550
    if tree.get_root_id() is not None:
1370
2551
        # This is kind of a hack: we should be altering the root
1371
2552
        # as part of the regular tree shape diff logic.
1372
2553
        # The conditional test here is to avoid doing an
1383
2564
        pp.next_phase()
1384
2565
        file_trans_id[wt.get_root_id()] = \
1385
2566
            tt.trans_id_tree_file_id(wt.get_root_id())
1386
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
2567
        pb = ui.ui_factory.nested_progress_bar()
1387
2568
        try:
1388
2569
            deferred_contents = []
 
2570
            num = 0
 
2571
            total = len(tree.all_file_ids())
 
2572
            if delta_from_tree:
 
2573
                precomputed_delta = []
 
2574
            else:
 
2575
                precomputed_delta = None
 
2576
            # Check if tree inventory has content. If so, we populate
 
2577
            # existing_files with the directory content. If there are no
 
2578
            # entries we skip populating existing_files as its not used.
 
2579
            # This improves performance and unncessary work on large
 
2580
            # directory trees. (#501307)
 
2581
            if total > 0:
 
2582
                existing_files = set()
 
2583
                for dir, files in wt.walkdirs():
 
2584
                    existing_files.update(f[0] for f in files)
1389
2585
            for num, (tree_path, entry) in \
1390
 
                enumerate(tree.inventory.iter_entries_by_dir()):
1391
 
                pb.update("Building tree", num - len(deferred_contents),
1392
 
                          len(tree.inventory))
 
2586
                enumerate(tree.iter_entries_by_dir()):
 
2587
                pb.update(gettext("Building tree"), num - len(deferred_contents), total)
1393
2588
                if entry.parent_id is None:
1394
2589
                    continue
1395
2590
                reparent = False
1396
2591
                file_id = entry.file_id
1397
 
                target_path = wt.abspath(tree_path)
1398
 
                try:
 
2592
                if delta_from_tree:
 
2593
                    precomputed_delta.append((None, tree_path, file_id, entry))
 
2594
                if tree_path in existing_files:
 
2595
                    target_path = wt.abspath(tree_path)
1399
2596
                    kind = file_kind(target_path)
1400
 
                except NoSuchFile:
1401
 
                    pass
1402
 
                else:
1403
2597
                    if kind == "directory":
1404
2598
                        try:
1405
 
                            bzrdir.BzrDir.open(target_path)
 
2599
                            controldir.ControlDir.open(target_path)
1406
2600
                        except errors.NotBranchError:
1407
2601
                            pass
1408
2602
                        else:
1413
2607
                        tt.delete_contents(tt.trans_id_tree_path(tree_path))
1414
2608
                        if kind == 'directory':
1415
2609
                            reparent = True
1416
 
                if entry.parent_id not in file_trans_id:
1417
 
                    raise AssertionError(
1418
 
                        'entry %s parent id %r is not in file_trans_id %r'
1419
 
                        % (entry, entry.parent_id, file_trans_id))
1420
2610
                parent_id = file_trans_id[entry.parent_id]
1421
2611
                if entry.kind == 'file':
1422
2612
                    # We *almost* replicate new_by_entry, so that we can defer
1423
2613
                    # getting the file text, and get them all at once.
1424
2614
                    trans_id = tt.create_path(entry.name, parent_id)
1425
2615
                    file_trans_id[file_id] = trans_id
1426
 
                    tt.version_file(entry.file_id, trans_id)
1427
 
                    executable = tree.is_executable(entry.file_id, tree_path)
1428
 
                    if executable is not None:
 
2616
                    tt.version_file(file_id, trans_id)
 
2617
                    executable = tree.is_executable(file_id, tree_path)
 
2618
                    if executable:
1429
2619
                        tt.set_executability(executable, trans_id)
1430
 
                    deferred_contents.append((entry.file_id, trans_id))
 
2620
                    trans_data = (trans_id, tree_path, entry.text_sha1)
 
2621
                    deferred_contents.append((file_id, trans_data))
1431
2622
                else:
1432
2623
                    file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1433
2624
                                                          tree)
1435
2626
                    new_trans_id = file_trans_id[file_id]
1436
2627
                    old_parent = tt.trans_id_tree_path(tree_path)
1437
2628
                    _reparent_children(tt, old_parent, new_trans_id)
1438
 
            for num, (trans_id, bytes) in enumerate(
1439
 
                _iter_files_bytes_accelerated(tree, accelerator_tree,
1440
 
                                              deferred_contents)):
1441
 
                tt.create_file(bytes, trans_id)
1442
 
                pb.update('Adding file contents',
1443
 
                          (num + len(tree.inventory) - len(deferred_contents)),
1444
 
                          len(tree.inventory))
 
2629
            offset = num + 1 - len(deferred_contents)
 
2630
            _create_files(tt, tree, deferred_contents, pb, offset,
 
2631
                          accelerator_tree, hardlink)
1445
2632
        finally:
1446
2633
            pb.finished()
1447
2634
        pp.next_phase()
1448
2635
        divert_trans = set(file_trans_id[f] for f in divert)
1449
2636
        resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1450
2637
        raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
 
2638
        if len(raw_conflicts) > 0:
 
2639
            precomputed_delta = None
1451
2640
        conflicts = cook_conflicts(raw_conflicts, tt)
1452
2641
        for conflict in conflicts:
1453
 
            warning(conflict)
 
2642
            trace.warning(unicode(conflict))
1454
2643
        try:
1455
2644
            wt.add_conflicts(conflicts)
1456
2645
        except errors.UnsupportedOperation:
1457
2646
            pass
1458
 
        result = tt.apply(no_conflicts=True)
 
2647
        result = tt.apply(no_conflicts=True,
 
2648
                          precomputed_delta=precomputed_delta)
1459
2649
    finally:
1460
2650
        tt.finalize()
1461
2651
        top_pb.finished()
1462
2652
    return result
1463
2653
 
1464
2654
 
1465
 
def _iter_files_bytes_accelerated(tree, accelerator_tree, desired_files):
 
2655
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
 
2656
                  hardlink):
 
2657
    total = len(desired_files) + offset
 
2658
    wt = tt._tree
1466
2659
    if accelerator_tree is None:
1467
2660
        new_desired_files = desired_files
1468
2661
    else:
1469
 
        iter = accelerator_tree._iter_changes(tree, include_unchanged=True)
1470
 
        unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1471
 
                         in iter if not c)
 
2662
        iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
 
2663
        unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
 
2664
                     in iter if not (c or e[0] != e[1])]
 
2665
        if accelerator_tree.supports_content_filtering():
 
2666
            unchanged = [(f, p) for (f, p) in unchanged
 
2667
                         if not accelerator_tree.iter_search_rules([p]).next()]
 
2668
        unchanged = dict(unchanged)
1472
2669
        new_desired_files = []
1473
 
        for file_id, identifier in desired_files:
 
2670
        count = 0
 
2671
        for file_id, (trans_id, tree_path, text_sha1) in desired_files:
1474
2672
            accelerator_path = unchanged.get(file_id)
1475
2673
            if accelerator_path is None:
1476
 
                new_desired_files.append((file_id, identifier))
 
2674
                new_desired_files.append((file_id,
 
2675
                    (trans_id, tree_path, text_sha1)))
1477
2676
                continue
1478
 
            contents = accelerator_tree.get_file(file_id, accelerator_path)
1479
 
            try:
1480
 
                want_new = False
1481
 
                contents_bytes = (contents.read(),)
1482
 
            finally:
1483
 
                contents.close()
1484
 
            yield identifier, contents_bytes
1485
 
    for result in tree.iter_files_bytes(new_desired_files):
1486
 
        yield result
 
2677
            pb.update(gettext('Adding file contents'), count + offset, total)
 
2678
            if hardlink:
 
2679
                tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
 
2680
                                   trans_id)
 
2681
            else:
 
2682
                contents = accelerator_tree.get_file(file_id, accelerator_path)
 
2683
                if wt.supports_content_filtering():
 
2684
                    filters = wt._content_filter_stack(tree_path)
 
2685
                    contents = filtered_output_bytes(contents, filters,
 
2686
                        ContentFilterContext(tree_path, tree))
 
2687
                try:
 
2688
                    tt.create_file(contents, trans_id, sha1=text_sha1)
 
2689
                finally:
 
2690
                    try:
 
2691
                        contents.close()
 
2692
                    except AttributeError:
 
2693
                        # after filtering, contents may no longer be file-like
 
2694
                        pass
 
2695
            count += 1
 
2696
        offset += count
 
2697
    for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
 
2698
            tree.iter_files_bytes(new_desired_files)):
 
2699
        if wt.supports_content_filtering():
 
2700
            filters = wt._content_filter_stack(tree_path)
 
2701
            contents = filtered_output_bytes(contents, filters,
 
2702
                ContentFilterContext(tree_path, tree))
 
2703
        tt.create_file(contents, trans_id, sha1=text_sha1)
 
2704
        pb.update(gettext('Adding file contents'), count + offset, total)
1487
2705
 
1488
2706
 
1489
2707
def _reparent_children(tt, old_parent, new_parent):
1491
2709
        tt.adjust_path(tt.final_name(child), new_parent, child)
1492
2710
 
1493
2711
 
 
2712
def _reparent_transform_children(tt, old_parent, new_parent):
 
2713
    by_parent = tt.by_parent()
 
2714
    for child in by_parent[old_parent]:
 
2715
        tt.adjust_path(tt.final_name(child), new_parent, child)
 
2716
    return by_parent[old_parent]
 
2717
 
 
2718
 
1494
2719
def _content_match(tree, entry, file_id, kind, target_path):
1495
2720
    if entry.kind != kind:
1496
2721
        return False
1497
2722
    if entry.kind == "directory":
1498
2723
        return True
1499
2724
    if entry.kind == "file":
1500
 
        if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1501
 
            return True
 
2725
        f = file(target_path, 'rb')
 
2726
        try:
 
2727
            if tree.get_file_text(file_id) == f.read():
 
2728
                return True
 
2729
        finally:
 
2730
            f.close()
1502
2731
    elif entry.kind == "symlink":
1503
2732
        if tree.get_symlink_target(file_id) == os.readlink(target_path):
1504
2733
            return True
1509
2738
    new_conflicts = set()
1510
2739
    for c_type, conflict in ((c[0], c) for c in conflicts):
1511
2740
        # Anything but a 'duplicate' would indicate programmer error
1512
 
        assert c_type == 'duplicate', c_type
 
2741
        if c_type != 'duplicate':
 
2742
            raise AssertionError(c_type)
1513
2743
        # Now figure out which is new and which is old
1514
2744
        if tt.new_contents(conflict[1]):
1515
2745
            new_file = conflict[1]
1541
2771
    if kind == 'file':
1542
2772
        contents = tree.get_file(entry.file_id).readlines()
1543
2773
        executable = tree.is_executable(entry.file_id)
1544
 
        return tt.new_file(name, parent_id, contents, entry.file_id, 
 
2774
        return tt.new_file(name, parent_id, contents, entry.file_id,
1545
2775
                           executable)
1546
2776
    elif kind in ('directory', 'tree-reference'):
1547
2777
        trans_id = tt.new_directory(name, parent_id, entry.file_id)
1548
2778
        if kind == 'tree-reference':
1549
2779
            tt.set_tree_reference(entry.reference_revision, trans_id)
1550
 
        return trans_id 
 
2780
        return trans_id
1551
2781
    elif kind == 'symlink':
1552
2782
        target = tree.get_symlink_target(entry.file_id)
1553
2783
        return tt.new_symlink(name, parent_id, target, entry.file_id)
1555
2785
        raise errors.BadFileKindError(name, kind)
1556
2786
 
1557
2787
 
1558
 
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1559
 
    """Create new file contents according to an inventory entry."""
1560
 
    if entry.kind == "file":
1561
 
        if lines is None:
1562
 
            lines = tree.get_file(entry.file_id).readlines()
1563
 
        tt.create_file(lines, trans_id, mode_id=mode_id)
1564
 
    elif entry.kind == "symlink":
1565
 
        tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1566
 
    elif entry.kind == "directory":
 
2788
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
 
2789
    filter_tree_path=None):
 
2790
    """Create new file contents according to tree contents.
 
2791
    
 
2792
    :param filter_tree_path: the tree path to use to lookup
 
2793
      content filters to apply to the bytes output in the working tree.
 
2794
      This only applies if the working tree supports content filtering.
 
2795
    """
 
2796
    kind = tree.kind(file_id)
 
2797
    if kind == 'directory':
1567
2798
        tt.create_directory(trans_id)
 
2799
    elif kind == "file":
 
2800
        if bytes is None:
 
2801
            tree_file = tree.get_file(file_id)
 
2802
            try:
 
2803
                bytes = tree_file.readlines()
 
2804
            finally:
 
2805
                tree_file.close()
 
2806
        wt = tt._tree
 
2807
        if wt.supports_content_filtering() and filter_tree_path is not None:
 
2808
            filters = wt._content_filter_stack(filter_tree_path)
 
2809
            bytes = filtered_output_bytes(bytes, filters,
 
2810
                ContentFilterContext(filter_tree_path, tree))
 
2811
        tt.create_file(bytes, trans_id)
 
2812
    elif kind == "symlink":
 
2813
        tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
 
2814
    else:
 
2815
        raise AssertionError('Unknown kind %r' % kind)
1568
2816
 
1569
2817
 
1570
2818
def create_entry_executability(tt, entry, trans_id):
1573
2821
        tt.set_executability(entry.executable, trans_id)
1574
2822
 
1575
2823
 
1576
 
@deprecated_function(zero_fifteen)
1577
 
def find_interesting(working_tree, target_tree, filenames):
1578
 
    """Find the ids corresponding to specified filenames.
1579
 
    
1580
 
    Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1581
 
    """
1582
 
    working_tree.lock_read()
1583
 
    try:
1584
 
        target_tree.lock_read()
1585
 
        try:
1586
 
            return working_tree.paths2ids(filenames, [target_tree])
1587
 
        finally:
1588
 
            target_tree.unlock()
1589
 
    finally:
1590
 
        working_tree.unlock()
1591
 
 
1592
 
 
1593
 
@deprecated_function(zero_ninety)
1594
 
def change_entry(tt, file_id, working_tree, target_tree, 
1595
 
                 trans_id_file_id, backups, trans_id, by_parent):
1596
 
    """Replace a file_id's contents with those from a target tree."""
1597
 
    if file_id is None and target_tree is None:
1598
 
        # skip the logic altogether in the deprecation test
1599
 
        return
1600
 
    e_trans_id = trans_id_file_id(file_id)
1601
 
    entry = target_tree.inventory[file_id]
1602
 
    has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry, 
1603
 
                                                           working_tree)
1604
 
    if contents_mod:
1605
 
        mode_id = e_trans_id
1606
 
        if has_contents:
1607
 
            if not backups:
1608
 
                tt.delete_contents(e_trans_id)
1609
 
            else:
1610
 
                parent_trans_id = trans_id_file_id(entry.parent_id)
1611
 
                backup_name = get_backup_name(entry, by_parent,
1612
 
                                              parent_trans_id, tt)
1613
 
                tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1614
 
                tt.unversion_file(e_trans_id)
1615
 
                e_trans_id = tt.create_path(entry.name, parent_trans_id)
1616
 
                tt.version_file(file_id, e_trans_id)
1617
 
                trans_id[file_id] = e_trans_id
1618
 
        create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1619
 
        create_entry_executability(tt, entry, e_trans_id)
1620
 
 
1621
 
    elif meta_mod:
1622
 
        tt.set_executability(entry.executable, e_trans_id)
1623
 
    if tt.final_name(e_trans_id) != entry.name:
1624
 
        adjust_path  = True
1625
 
    else:
1626
 
        parent_id = tt.final_parent(e_trans_id)
1627
 
        parent_file_id = tt.final_file_id(parent_id)
1628
 
        if parent_file_id != entry.parent_id:
1629
 
            adjust_path = True
1630
 
        else:
1631
 
            adjust_path = False
1632
 
    if adjust_path:
1633
 
        parent_trans_id = trans_id_file_id(entry.parent_id)
1634
 
        tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1635
 
 
1636
 
 
 
2824
@deprecated_function(deprecated_in((2, 3, 0)))
1637
2825
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1638
2826
    return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1639
2827
 
1640
2828
 
 
2829
@deprecated_function(deprecated_in((2, 3, 0)))
1641
2830
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1642
2831
    """Produce a backup-style name that appears to be available"""
1643
2832
    def name_gen():
1650
2839
            return new_name
1651
2840
 
1652
2841
 
1653
 
def _entry_changes(file_id, entry, working_tree):
1654
 
    """Determine in which ways the inventory entry has changed.
1655
 
 
1656
 
    Returns booleans: has_contents, content_mod, meta_mod
1657
 
    has_contents means there are currently contents, but they differ
1658
 
    contents_mod means contents need to be modified
1659
 
    meta_mod means the metadata needs to be modified
1660
 
    """
1661
 
    cur_entry = working_tree.inventory[file_id]
1662
 
    try:
1663
 
        working_kind = working_tree.kind(file_id)
1664
 
        has_contents = True
1665
 
    except NoSuchFile:
1666
 
        has_contents = False
1667
 
        contents_mod = True
1668
 
        meta_mod = False
1669
 
    if has_contents is True:
1670
 
        if entry.kind != working_kind:
1671
 
            contents_mod, meta_mod = True, False
1672
 
        else:
1673
 
            cur_entry._read_tree_state(working_tree.id2path(file_id), 
1674
 
                                       working_tree)
1675
 
            contents_mod, meta_mod = entry.detect_changes(cur_entry)
1676
 
            cur_entry._forget_tree_state()
1677
 
    return has_contents, contents_mod, meta_mod
1678
 
 
1679
 
 
1680
2842
def revert(working_tree, target_tree, filenames, backups=False,
1681
 
           pb=DummyProgress(), change_reporter=None):
 
2843
           pb=None, change_reporter=None):
1682
2844
    """Revert a working tree's contents to those of a target tree."""
1683
2845
    target_tree.lock_read()
 
2846
    pb = ui.ui_factory.nested_progress_bar()
1684
2847
    tt = TreeTransform(working_tree, pb)
1685
2848
    try:
1686
2849
        pp = ProgressPhase("Revert phase", 3, pb)
1687
 
        pp.next_phase()
1688
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1689
 
        try:
1690
 
            merge_modified = _alter_files(working_tree, target_tree, tt,
1691
 
                                          child_pb, filenames, backups)
1692
 
        finally:
1693
 
            child_pb.finished()
1694
 
        pp.next_phase()
1695
 
        child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1696
 
        try:
1697
 
            raw_conflicts = resolve_conflicts(tt, child_pb,
1698
 
                lambda t, c: conflict_pass(t, c, target_tree))
1699
 
        finally:
1700
 
            child_pb.finished()
1701
 
        conflicts = cook_conflicts(raw_conflicts, tt)
 
2850
        conflicts, merge_modified = _prepare_revert_transform(
 
2851
            working_tree, target_tree, tt, filenames, backups, pp)
1702
2852
        if change_reporter:
1703
2853
            change_reporter = delta._ChangeReporter(
1704
2854
                unversioned_filter=working_tree.is_ignored)
1705
 
            delta.report_changes(tt._iter_changes(), change_reporter)
 
2855
            delta.report_changes(tt.iter_changes(), change_reporter)
1706
2856
        for conflict in conflicts:
1707
 
            warning(conflict)
 
2857
            trace.warning(unicode(conflict))
1708
2858
        pp.next_phase()
1709
2859
        tt.apply()
1710
2860
        working_tree.set_merge_modified(merge_modified)
1715
2865
    return conflicts
1716
2866
 
1717
2867
 
 
2868
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
 
2869
                              backups, pp, basis_tree=None,
 
2870
                              merge_modified=None):
 
2871
    child_pb = ui.ui_factory.nested_progress_bar()
 
2872
    try:
 
2873
        if merge_modified is None:
 
2874
            merge_modified = working_tree.merge_modified()
 
2875
        merge_modified = _alter_files(working_tree, target_tree, tt,
 
2876
                                      child_pb, filenames, backups,
 
2877
                                      merge_modified, basis_tree)
 
2878
    finally:
 
2879
        child_pb.finished()
 
2880
    child_pb = ui.ui_factory.nested_progress_bar()
 
2881
    try:
 
2882
        raw_conflicts = resolve_conflicts(tt, child_pb,
 
2883
            lambda t, c: conflict_pass(t, c, target_tree))
 
2884
    finally:
 
2885
        child_pb.finished()
 
2886
    conflicts = cook_conflicts(raw_conflicts, tt)
 
2887
    return conflicts, merge_modified
 
2888
 
 
2889
 
1718
2890
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1719
 
                 backups):
1720
 
    merge_modified = working_tree.merge_modified()
1721
 
    change_list = target_tree._iter_changes(working_tree,
 
2891
                 backups, merge_modified, basis_tree=None):
 
2892
    if basis_tree is not None:
 
2893
        basis_tree.lock_read()
 
2894
    # We ask the working_tree for its changes relative to the target, rather
 
2895
    # than the target changes relative to the working tree. Because WT4 has an
 
2896
    # optimizer to compare itself to a target, but no optimizer for the
 
2897
    # reverse.
 
2898
    change_list = working_tree.iter_changes(target_tree,
1722
2899
        specific_files=specific_files, pb=pb)
1723
 
    if target_tree.inventory.root is None:
 
2900
    if target_tree.get_root_id() is None:
1724
2901
        skip_root = True
1725
2902
    else:
1726
2903
        skip_root = False
1727
 
    basis_tree = None
1728
2904
    try:
1729
2905
        deferred_files = []
1730
2906
        for id_num, (file_id, path, changed_content, versioned, parent, name,
1731
2907
                kind, executable) in enumerate(change_list):
1732
 
            if skip_root and file_id[0] is not None and parent[0] is None:
 
2908
            target_path, wt_path = path
 
2909
            target_versioned, wt_versioned = versioned
 
2910
            target_parent, wt_parent = parent
 
2911
            target_name, wt_name = name
 
2912
            target_kind, wt_kind = kind
 
2913
            target_executable, wt_executable = executable
 
2914
            if skip_root and wt_parent is None:
1733
2915
                continue
1734
2916
            trans_id = tt.trans_id_file_id(file_id)
1735
2917
            mode_id = None
1736
2918
            if changed_content:
1737
2919
                keep_content = False
1738
 
                if kind[0] == 'file' and (backups or kind[1] is None):
 
2920
                if wt_kind == 'file' and (backups or target_kind is None):
1739
2921
                    wt_sha1 = working_tree.get_file_sha1(file_id)
1740
2922
                    if merge_modified.get(file_id) != wt_sha1:
1741
2923
                        # acquire the basis tree lazily to prevent the
1744
2926
                        if basis_tree is None:
1745
2927
                            basis_tree = working_tree.basis_tree()
1746
2928
                            basis_tree.lock_read()
1747
 
                        if file_id in basis_tree:
 
2929
                        if basis_tree.has_id(file_id):
1748
2930
                            if wt_sha1 != basis_tree.get_file_sha1(file_id):
1749
2931
                                keep_content = True
1750
 
                        elif kind[1] is None and not versioned[1]:
 
2932
                        elif target_kind is None and not target_versioned:
1751
2933
                            keep_content = True
1752
 
                if kind[0] is not None:
 
2934
                if wt_kind is not None:
1753
2935
                    if not keep_content:
1754
2936
                        tt.delete_contents(trans_id)
1755
 
                    elif kind[1] is not None:
1756
 
                        parent_trans_id = tt.trans_id_file_id(parent[0])
1757
 
                        by_parent = tt.by_parent()
1758
 
                        backup_name = _get_backup_name(name[0], by_parent,
1759
 
                                                       parent_trans_id, tt)
 
2937
                    elif target_kind is not None:
 
2938
                        parent_trans_id = tt.trans_id_file_id(wt_parent)
 
2939
                        backup_name = tt._available_backup_name(
 
2940
                            wt_name, parent_trans_id)
1760
2941
                        tt.adjust_path(backup_name, parent_trans_id, trans_id)
1761
 
                        new_trans_id = tt.create_path(name[0], parent_trans_id)
1762
 
                        if versioned == (True, True):
 
2942
                        new_trans_id = tt.create_path(wt_name, parent_trans_id)
 
2943
                        if wt_versioned and target_versioned:
1763
2944
                            tt.unversion_file(trans_id)
1764
2945
                            tt.version_file(file_id, new_trans_id)
1765
2946
                        # New contents should have the same unix perms as old
1766
2947
                        # contents
1767
2948
                        mode_id = trans_id
1768
2949
                        trans_id = new_trans_id
1769
 
                if kind[1] == 'directory':
 
2950
                if target_kind in ('directory', 'tree-reference'):
1770
2951
                    tt.create_directory(trans_id)
1771
 
                elif kind[1] == 'symlink':
 
2952
                    if target_kind == 'tree-reference':
 
2953
                        revision = target_tree.get_reference_revision(file_id,
 
2954
                                                                      target_path)
 
2955
                        tt.set_tree_reference(revision, trans_id)
 
2956
                elif target_kind == 'symlink':
1772
2957
                    tt.create_symlink(target_tree.get_symlink_target(file_id),
1773
2958
                                      trans_id)
1774
 
                elif kind[1] == 'file':
 
2959
                elif target_kind == 'file':
1775
2960
                    deferred_files.append((file_id, (trans_id, mode_id)))
1776
2961
                    if basis_tree is None:
1777
2962
                        basis_tree = working_tree.basis_tree()
1778
2963
                        basis_tree.lock_read()
1779
2964
                    new_sha1 = target_tree.get_file_sha1(file_id)
1780
 
                    if (file_id in basis_tree and new_sha1 ==
1781
 
                        basis_tree.get_file_sha1(file_id)):
 
2965
                    if (basis_tree.has_id(file_id) and
 
2966
                        new_sha1 == basis_tree.get_file_sha1(file_id)):
1782
2967
                        if file_id in merge_modified:
1783
2968
                            del merge_modified[file_id]
1784
2969
                    else:
1785
2970
                        merge_modified[file_id] = new_sha1
1786
2971
 
1787
2972
                    # preserve the execute bit when backing up
1788
 
                    if keep_content and executable[0] == executable[1]:
1789
 
                        tt.set_executability(executable[1], trans_id)
1790
 
                else:
1791
 
                    assert kind[1] is None
1792
 
            if versioned == (False, True):
 
2973
                    if keep_content and wt_executable == target_executable:
 
2974
                        tt.set_executability(target_executable, trans_id)
 
2975
                elif target_kind is not None:
 
2976
                    raise AssertionError(target_kind)
 
2977
            if not wt_versioned and target_versioned:
1793
2978
                tt.version_file(file_id, trans_id)
1794
 
            if versioned == (True, False):
 
2979
            if wt_versioned and not target_versioned:
1795
2980
                tt.unversion_file(trans_id)
1796
 
            if (name[1] is not None and 
1797
 
                (name[0] != name[1] or parent[0] != parent[1])):
1798
 
                tt.adjust_path(
1799
 
                    name[1], tt.trans_id_file_id(parent[1]), trans_id)
1800
 
            if executable[0] != executable[1] and kind[1] == "file":
1801
 
                tt.set_executability(executable[1], trans_id)
1802
 
        for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1803
 
            deferred_files):
1804
 
            tt.create_file(bytes, trans_id, mode_id)
 
2981
            if (target_name is not None and
 
2982
                (wt_name != target_name or wt_parent != target_parent)):
 
2983
                if target_name == '' and target_parent is None:
 
2984
                    parent_trans = ROOT_PARENT
 
2985
                else:
 
2986
                    parent_trans = tt.trans_id_file_id(target_parent)
 
2987
                if wt_parent is None and wt_versioned:
 
2988
                    tt.adjust_root_path(target_name, parent_trans)
 
2989
                else:
 
2990
                    tt.adjust_path(target_name, parent_trans, trans_id)
 
2991
            if wt_executable != target_executable and target_kind == "file":
 
2992
                tt.set_executability(target_executable, trans_id)
 
2993
        if working_tree.supports_content_filtering():
 
2994
            for index, ((trans_id, mode_id), bytes) in enumerate(
 
2995
                target_tree.iter_files_bytes(deferred_files)):
 
2996
                file_id = deferred_files[index][0]
 
2997
                # We're reverting a tree to the target tree so using the
 
2998
                # target tree to find the file path seems the best choice
 
2999
                # here IMO - Ian C 27/Oct/2009
 
3000
                filter_tree_path = target_tree.id2path(file_id)
 
3001
                filters = working_tree._content_filter_stack(filter_tree_path)
 
3002
                bytes = filtered_output_bytes(bytes, filters,
 
3003
                    ContentFilterContext(filter_tree_path, working_tree))
 
3004
                tt.create_file(bytes, trans_id, mode_id)
 
3005
        else:
 
3006
            for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
 
3007
                deferred_files):
 
3008
                tt.create_file(bytes, trans_id, mode_id)
 
3009
        tt.fixup_new_roots()
1805
3010
    finally:
1806
3011
        if basis_tree is not None:
1807
3012
            basis_tree.unlock()
1808
3013
    return merge_modified
1809
3014
 
1810
3015
 
1811
 
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
 
3016
def resolve_conflicts(tt, pb=None, pass_func=None):
1812
3017
    """Make many conflict-resolution attempts, but die if they fail"""
1813
3018
    if pass_func is None:
1814
3019
        pass_func = conflict_pass
1815
3020
    new_conflicts = set()
 
3021
    pb = ui.ui_factory.nested_progress_bar()
1816
3022
    try:
1817
3023
        for n in range(10):
1818
 
            pb.update('Resolution pass', n+1, 10)
 
3024
            pb.update(gettext('Resolution pass'), n+1, 10)
1819
3025
            conflicts = tt.find_conflicts()
1820
3026
            if len(conflicts) == 0:
1821
3027
                return new_conflicts
1822
3028
            new_conflicts.update(pass_func(tt, conflicts))
1823
3029
        raise MalformedTransform(conflicts=conflicts)
1824
3030
    finally:
1825
 
        pb.clear()
 
3031
        pb.finished()
1826
3032
 
1827
3033
 
1828
3034
def conflict_pass(tt, conflicts, path_tree=None):
1845
3051
                existing_file, new_file = conflict[2], conflict[1]
1846
3052
            else:
1847
3053
                existing_file, new_file = conflict[1], conflict[2]
1848
 
            new_name = tt.final_name(existing_file)+'.moved'
 
3054
            new_name = tt.final_name(existing_file) + '.moved'
1849
3055
            tt.adjust_path(new_name, final_parent, existing_file)
1850
 
            new_conflicts.add((c_type, 'Moved existing file to', 
 
3056
            new_conflicts.add((c_type, 'Moved existing file to',
1851
3057
                               existing_file, new_file))
1852
3058
        elif c_type == 'parent loop':
1853
3059
            # break the loop by undoing one of the ops that caused the loop
1857
3063
            new_conflicts.add((c_type, 'Cancelled move', cur,
1858
3064
                               tt.final_parent(cur),))
1859
3065
            tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1860
 
            
 
3066
 
1861
3067
        elif c_type == 'missing parent':
1862
3068
            trans_id = conflict[1]
1863
 
            try:
1864
 
                tt.cancel_deletion(trans_id)
1865
 
                new_conflicts.add(('deleting parent', 'Not deleting', 
1866
 
                                   trans_id))
1867
 
            except KeyError:
1868
 
                tt.create_directory(trans_id)
1869
 
                new_conflicts.add((c_type, 'Created directory', trans_id))
 
3069
            if trans_id in tt._removed_contents:
 
3070
                cancel_deletion = True
 
3071
                orphans = tt._get_potential_orphans(trans_id)
 
3072
                if orphans:
 
3073
                    cancel_deletion = False
 
3074
                    # All children are orphans
 
3075
                    for o in orphans:
 
3076
                        try:
 
3077
                            tt.new_orphan(o, trans_id)
 
3078
                        except OrphaningError:
 
3079
                            # Something bad happened so we cancel the directory
 
3080
                            # deletion which will leave it in place with a
 
3081
                            # conflict. The user can deal with it from there.
 
3082
                            # Note that this also catch the case where we don't
 
3083
                            # want to create orphans and leave the directory in
 
3084
                            # place.
 
3085
                            cancel_deletion = True
 
3086
                            break
 
3087
                if cancel_deletion:
 
3088
                    # Cancel the directory deletion
 
3089
                    tt.cancel_deletion(trans_id)
 
3090
                    new_conflicts.add(('deleting parent', 'Not deleting',
 
3091
                                       trans_id))
 
3092
            else:
 
3093
                create = True
1870
3094
                try:
1871
3095
                    tt.final_name(trans_id)
1872
3096
                except NoFinalPath:
1873
3097
                    if path_tree is not None:
1874
3098
                        file_id = tt.final_file_id(trans_id)
1875
 
                        entry = path_tree.inventory[file_id]
1876
 
                        parent_trans_id = tt.trans_id_file_id(entry.parent_id)
1877
 
                        tt.adjust_path(entry.name, parent_trans_id, trans_id)
 
3099
                        if file_id is None:
 
3100
                            file_id = tt.inactive_file_id(trans_id)
 
3101
                        _, entry = path_tree.iter_entries_by_dir(
 
3102
                            [file_id]).next()
 
3103
                        # special-case the other tree root (move its
 
3104
                        # children to current root)
 
3105
                        if entry.parent_id is None:
 
3106
                            create = False
 
3107
                            moved = _reparent_transform_children(
 
3108
                                tt, trans_id, tt.root)
 
3109
                            for child in moved:
 
3110
                                new_conflicts.add((c_type, 'Moved to root',
 
3111
                                                   child))
 
3112
                        else:
 
3113
                            parent_trans_id = tt.trans_id_file_id(
 
3114
                                entry.parent_id)
 
3115
                            tt.adjust_path(entry.name, parent_trans_id,
 
3116
                                           trans_id)
 
3117
                if create:
 
3118
                    tt.create_directory(trans_id)
 
3119
                    new_conflicts.add((c_type, 'Created directory', trans_id))
1878
3120
        elif c_type == 'unversioned parent':
1879
 
            tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
 
3121
            file_id = tt.inactive_file_id(conflict[1])
 
3122
            # special-case the other tree root (move its children instead)
 
3123
            if path_tree and path_tree.has_id(file_id):
 
3124
                if path_tree.path2id('') == file_id:
 
3125
                    # This is the root entry, skip it
 
3126
                    continue
 
3127
            tt.version_file(file_id, conflict[1])
1880
3128
            new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
 
3129
        elif c_type == 'non-directory parent':
 
3130
            parent_id = conflict[1]
 
3131
            parent_parent = tt.final_parent(parent_id)
 
3132
            parent_name = tt.final_name(parent_id)
 
3133
            parent_file_id = tt.final_file_id(parent_id)
 
3134
            new_parent_id = tt.new_directory(parent_name + '.new',
 
3135
                parent_parent, parent_file_id)
 
3136
            _reparent_transform_children(tt, parent_id, new_parent_id)
 
3137
            if parent_file_id is not None:
 
3138
                tt.unversion_file(parent_id)
 
3139
            new_conflicts.add((c_type, 'Created directory', new_parent_id))
 
3140
        elif c_type == 'versioning no contents':
 
3141
            tt.cancel_versioning(conflict[1])
1881
3142
    return new_conflicts
1882
3143
 
1883
3144
 
1884
3145
def cook_conflicts(raw_conflicts, tt):
1885
3146
    """Generate a list of cooked conflicts, sorted by file path"""
1886
 
    from bzrlib.conflicts import Conflict
1887
3147
    conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
1888
 
    return sorted(conflict_iter, key=Conflict.sort_key)
 
3148
    return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
1889
3149
 
1890
3150
 
1891
3151
def iter_cook_conflicts(raw_conflicts, tt):
1892
 
    from bzrlib.conflicts import Conflict
1893
3152
    fp = FinalPaths(tt)
1894
3153
    for conflict in raw_conflicts:
1895
3154
        c_type = conflict[0]
1897
3156
        modified_path = fp.get_path(conflict[2])
1898
3157
        modified_id = tt.final_file_id(conflict[2])
1899
3158
        if len(conflict) == 3:
1900
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
1901
 
                                     file_id=modified_id)
1902
 
             
 
3159
            yield conflicts.Conflict.factory(
 
3160
                c_type, action=action, path=modified_path, file_id=modified_id)
 
3161
 
1903
3162
        else:
1904
3163
            conflicting_path = fp.get_path(conflict[3])
1905
3164
            conflicting_id = tt.final_file_id(conflict[3])
1906
 
            yield Conflict.factory(c_type, action=action, path=modified_path,
1907
 
                                   file_id=modified_id, 
1908
 
                                   conflict_path=conflicting_path,
1909
 
                                   conflict_file_id=conflicting_id)
 
3165
            yield conflicts.Conflict.factory(
 
3166
                c_type, action=action, path=modified_path,
 
3167
                file_id=modified_id,
 
3168
                conflict_path=conflicting_path,
 
3169
                conflict_file_id=conflicting_id)
1910
3170
 
1911
3171
 
1912
3172
class _FileMover(object):
1917
3177
        self.pending_deletions = []
1918
3178
 
1919
3179
    def rename(self, from_, to):
1920
 
        """Rename a file from one path to another.  Functions like os.rename"""
 
3180
        """Rename a file from one path to another."""
1921
3181
        try:
1922
3182
            os.rename(from_, to)
1923
3183
        except OSError, e:
1924
3184
            if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
1925
3185
                raise errors.FileExists(to, str(e))
1926
 
            raise
 
3186
            # normal OSError doesn't include filenames so it's hard to see where
 
3187
            # the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
 
3188
            raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
1927
3189
        self.past_renames.append((from_, to))
1928
3190
 
1929
3191
    def pre_delete(self, from_, to):
1939
3201
    def rollback(self):
1940
3202
        """Reverse all renames that have been performed"""
1941
3203
        for from_, to in reversed(self.past_renames):
1942
 
            os.rename(to, from_)
 
3204
            try:
 
3205
                os.rename(to, from_)
 
3206
            except OSError, e:
 
3207
                raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
1943
3208
        # after rollback, don't reuse _FileMover
1944
3209
        past_renames = None
1945
3210
        pending_deletions = None