/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 bzrlib/transform.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-20 22:42:34 UTC
  • mfrom: (6083.1.2 more-get-transport-from)
  • Revision ID: pqm@pqm.ubuntu.com-20110820224234-l0c0cmesdnfp2srq
(jelmer) Use get_transport_from_path and get_transport_from_url in more
 places. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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