/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/transform.py

  • Committer: Jelmer Vernooij
  • Date: 2018-12-10 01:46:35 UTC
  • mto: This revision was merged to the branch mainline in revision 7219.
  • Revision ID: jelmer@jelmer.uk-20181210014635-oxhnf8s46u0nvp5c
Fix import

Show diffs side-by-side

added added

removed removed

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