1
# Copyright (C) 2006-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from stat import S_ISREG, S_IEXEC
25
config as _mod_config,
32
lazy_import.lazy_import(globals(), """
43
revision as _mod_revision,
47
from bzrlib.i18n import gettext
49
from bzrlib.errors import (DuplicateKey, MalformedTransform,
50
ReusingTransform, CantMoveRoot,
51
ImmortalLimbo, NoFinalPath,
53
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
54
from bzrlib.mutabletree import MutableTree
55
from bzrlib.osutils import (
63
from bzrlib.progress import ProgressPhase
64
from bzrlib.symbol_versioning import (
71
ROOT_PARENT = "root-parent"
73
def unique_add(map, key, value):
75
raise DuplicateKey(key=key)
80
class _TransformResults(object):
81
def __init__(self, modified_paths, rename_count):
83
self.modified_paths = modified_paths
84
self.rename_count = rename_count
87
class TreeTransformBase(object):
88
"""The base class for TreeTransform and its kin."""
90
def __init__(self, tree, pb=None,
94
:param tree: The tree that will be transformed, but not necessarily
97
:param case_sensitive: If True, the target of the transform is
98
case sensitive, not just case preserving.
100
object.__init__(self)
103
# mapping of trans_id -> new basename
105
# mapping of trans_id -> new parent trans_id
106
self._new_parent = {}
107
# mapping of trans_id with new contents -> new file_kind
108
self._new_contents = {}
109
# mapping of trans_id => (sha1 of content, stat_value)
110
self._observed_sha1s = {}
111
# Set of trans_ids whose contents will be removed
112
self._removed_contents = set()
113
# Mapping of trans_id -> new execute-bit value
114
self._new_executability = {}
115
# Mapping of trans_id -> new tree-reference value
116
self._new_reference_revision = {}
117
# Mapping of trans_id -> new file_id
119
# Mapping of old file-id -> trans_id
120
self._non_present_ids = {}
121
# Mapping of new file_id -> trans_id
123
# Set of trans_ids that will be removed
124
self._removed_id = set()
125
# Mapping of path in old tree -> trans_id
126
self._tree_path_ids = {}
127
# Mapping trans_id -> path in old tree
128
self._tree_id_paths = {}
129
# The trans_id that will be used as the tree root
130
root_id = tree.get_root_id()
131
if root_id is not None:
132
self._new_root = self.trans_id_tree_file_id(root_id)
134
self._new_root = None
135
# Indicator of whether the transform has been applied
139
# Whether the target is case sensitive
140
self._case_sensitive_target = case_sensitive
141
# A counter of how many files have been renamed
142
self.rename_count = 0
145
"""Support Context Manager API."""
148
def __exit__(self, exc_type, exc_val, exc_tb):
149
"""Support Context Manager API."""
153
"""Release the working tree lock, if held.
155
This is required if apply has not been invoked, but can be invoked
158
if self._tree is None:
160
for hook in MutableTree.hooks['post_transform']:
161
hook(self._tree, self)
165
def __get_root(self):
166
return self._new_root
168
root = property(__get_root)
170
def _assign_id(self):
171
"""Produce a new tranform id"""
172
new_id = "new-%s" % self._id_number
176
def create_path(self, name, parent):
177
"""Assign a transaction id to a new path"""
178
trans_id = self._assign_id()
179
unique_add(self._new_name, trans_id, name)
180
unique_add(self._new_parent, trans_id, parent)
183
def adjust_path(self, name, parent, trans_id):
184
"""Change the path that is assigned to a transaction id."""
186
raise ValueError("Parent trans-id may not be None")
187
if trans_id == self._new_root:
189
self._new_name[trans_id] = name
190
self._new_parent[trans_id] = parent
192
def adjust_root_path(self, name, parent):
193
"""Emulate moving the root by moving all children, instead.
195
We do this by undoing the association of root's transaction id with the
196
current tree. This allows us to create a new directory with that
197
transaction id. We unversion the root directory and version the
198
physically new directory, and hope someone versions the tree root
201
old_root = self._new_root
202
old_root_file_id = self.final_file_id(old_root)
203
# force moving all children of root
204
for child_id in self.iter_tree_children(old_root):
205
if child_id != parent:
206
self.adjust_path(self.final_name(child_id),
207
self.final_parent(child_id), child_id)
208
file_id = self.final_file_id(child_id)
209
if file_id is not None:
210
self.unversion_file(child_id)
211
self.version_file(file_id, child_id)
213
# the physical root needs a new transaction id
214
self._tree_path_ids.pop("")
215
self._tree_id_paths.pop(old_root)
216
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
217
if parent == old_root:
218
parent = self._new_root
219
self.adjust_path(name, parent, old_root)
220
self.create_directory(old_root)
221
self.version_file(old_root_file_id, old_root)
222
self.unversion_file(self._new_root)
224
def fixup_new_roots(self):
225
"""Reinterpret requests to change the root directory
227
Instead of creating a root directory, or moving an existing directory,
228
all the attributes and children of the new root are applied to the
229
existing root directory.
231
This means that the old root trans-id becomes obsolete, so it is
232
recommended only to invoke this after the root trans-id has become
236
new_roots = [k for k, v in self._new_parent.iteritems() if v ==
238
if len(new_roots) < 1:
240
if len(new_roots) != 1:
241
raise ValueError('A tree cannot have two roots!')
242
if self._new_root is None:
243
self._new_root = new_roots[0]
245
old_new_root = new_roots[0]
246
# unversion the new root's directory.
247
if self.final_kind(self._new_root) is None:
248
file_id = self.final_file_id(old_new_root)
250
file_id = self.final_file_id(self._new_root)
251
if old_new_root in self._new_id:
252
self.cancel_versioning(old_new_root)
254
self.unversion_file(old_new_root)
255
# if, at this stage, root still has an old file_id, zap it so we can
256
# stick a new one in.
257
if (self.tree_file_id(self._new_root) is not None and
258
self._new_root not in self._removed_id):
259
self.unversion_file(self._new_root)
260
if file_id is not None:
261
self.version_file(file_id, self._new_root)
263
# Now move children of new root into old root directory.
264
# Ensure all children are registered with the transaction, but don't
265
# use directly-- some tree children have new parents
266
list(self.iter_tree_children(old_new_root))
267
# Move all children of new root into old root directory.
268
for child in self.by_parent().get(old_new_root, []):
269
self.adjust_path(self.final_name(child), self._new_root, child)
271
# Ensure old_new_root has no directory.
272
if old_new_root in self._new_contents:
273
self.cancel_creation(old_new_root)
275
self.delete_contents(old_new_root)
277
# prevent deletion of root directory.
278
if self._new_root in self._removed_contents:
279
self.cancel_deletion(self._new_root)
281
# destroy path info for old_new_root.
282
del self._new_parent[old_new_root]
283
del self._new_name[old_new_root]
285
def trans_id_tree_file_id(self, inventory_id):
286
"""Determine the transaction id of a working tree file.
288
This reflects only files that already exist, not ones that will be
289
added by transactions.
291
if inventory_id is None:
292
raise ValueError('None is not a valid file id')
293
path = self._tree.id2path(inventory_id)
294
return self.trans_id_tree_path(path)
296
def trans_id_file_id(self, file_id):
297
"""Determine or set the transaction id associated with a file ID.
298
A new id is only created for file_ids that were never present. If
299
a transaction has been unversioned, it is deliberately still returned.
300
(this will likely lead to an unversioned parent conflict.)
303
raise ValueError('None is not a valid file id')
304
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
305
return self._r_new_id[file_id]
308
self._tree.iter_entries_by_dir([file_id]).next()
309
except StopIteration:
310
if file_id in self._non_present_ids:
311
return self._non_present_ids[file_id]
313
trans_id = self._assign_id()
314
self._non_present_ids[file_id] = trans_id
317
return self.trans_id_tree_file_id(file_id)
319
def trans_id_tree_path(self, path):
320
"""Determine (and maybe set) the transaction ID for a tree path."""
321
path = self.canonical_path(path)
322
if path not in self._tree_path_ids:
323
self._tree_path_ids[path] = self._assign_id()
324
self._tree_id_paths[self._tree_path_ids[path]] = path
325
return self._tree_path_ids[path]
327
def get_tree_parent(self, trans_id):
328
"""Determine id of the parent in the tree."""
329
path = self._tree_id_paths[trans_id]
332
return self.trans_id_tree_path(os.path.dirname(path))
334
def delete_contents(self, trans_id):
335
"""Schedule the contents of a path entry for deletion"""
336
kind = self.tree_kind(trans_id)
338
self._removed_contents.add(trans_id)
340
def cancel_deletion(self, trans_id):
341
"""Cancel a scheduled deletion"""
342
self._removed_contents.remove(trans_id)
344
def unversion_file(self, trans_id):
345
"""Schedule a path entry to become unversioned"""
346
self._removed_id.add(trans_id)
348
def delete_versioned(self, trans_id):
349
"""Delete and unversion a versioned file"""
350
self.delete_contents(trans_id)
351
self.unversion_file(trans_id)
353
def set_executability(self, executability, trans_id):
354
"""Schedule setting of the 'execute' bit
355
To unschedule, set to None
357
if executability is None:
358
del self._new_executability[trans_id]
360
unique_add(self._new_executability, trans_id, executability)
362
def set_tree_reference(self, revision_id, trans_id):
363
"""Set the reference associated with a directory"""
364
unique_add(self._new_reference_revision, trans_id, revision_id)
366
def version_file(self, file_id, trans_id):
367
"""Schedule a file to become versioned."""
370
unique_add(self._new_id, trans_id, file_id)
371
unique_add(self._r_new_id, file_id, trans_id)
373
def cancel_versioning(self, trans_id):
374
"""Undo a previous versioning of a file"""
375
file_id = self._new_id[trans_id]
376
del self._new_id[trans_id]
377
del self._r_new_id[file_id]
379
def new_paths(self, filesystem_only=False):
380
"""Determine the paths of all new and changed files.
382
:param filesystem_only: if True, only calculate values for files
383
that require renames or execute bit changes.
387
stale_ids = self._needs_rename.difference(self._new_name)
388
stale_ids.difference_update(self._new_parent)
389
stale_ids.difference_update(self._new_contents)
390
stale_ids.difference_update(self._new_id)
391
needs_rename = self._needs_rename.difference(stale_ids)
392
id_sets = (needs_rename, self._new_executability)
394
id_sets = (self._new_name, self._new_parent, self._new_contents,
395
self._new_id, self._new_executability)
396
for id_set in id_sets:
397
new_ids.update(id_set)
398
return sorted(FinalPaths(self).get_paths(new_ids))
400
def _inventory_altered(self):
401
"""Determine which trans_ids need new Inventory entries.
403
An new entry is needed when anything that would be reflected by an
404
inventory entry changes, including file name, file_id, parent file_id,
405
file kind, and the execute bit.
407
Some care is taken to return entries with real changes, not cases
408
where the value is deleted and then restored to its original value,
409
but some actually unchanged values may be returned.
411
:returns: A list of (path, trans_id) for all items requiring an
412
inventory change. Ordered by path.
415
# Find entries whose file_ids are new (or changed).
416
new_file_id = set(t for t in self._new_id
417
if self._new_id[t] != self.tree_file_id(t))
418
for id_set in [self._new_name, self._new_parent, new_file_id,
419
self._new_executability]:
420
changed_ids.update(id_set)
421
# removing implies a kind change
422
changed_kind = set(self._removed_contents)
424
changed_kind.intersection_update(self._new_contents)
425
# Ignore entries that are already known to have changed.
426
changed_kind.difference_update(changed_ids)
427
# to keep only the truly changed ones
428
changed_kind = (t for t in changed_kind
429
if self.tree_kind(t) != self.final_kind(t))
430
# all kind changes will alter the inventory
431
changed_ids.update(changed_kind)
432
# To find entries with changed parent_ids, find parents which existed,
433
# but changed file_id.
434
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
435
# Now add all their children to the set.
436
for parent_trans_id in new_file_id:
437
changed_ids.update(self.iter_tree_children(parent_trans_id))
438
return sorted(FinalPaths(self).get_paths(changed_ids))
440
def final_kind(self, trans_id):
441
"""Determine the final file kind, after any changes applied.
443
:return: None if the file does not exist/has no contents. (It is
444
conceivable that a path would be created without the corresponding
445
contents insertion command)
447
if trans_id in self._new_contents:
448
return self._new_contents[trans_id]
449
elif trans_id in self._removed_contents:
452
return self.tree_kind(trans_id)
454
def tree_file_id(self, trans_id):
455
"""Determine the file id associated with the trans_id in the tree"""
457
path = self._tree_id_paths[trans_id]
459
# the file is a new, unversioned file, or invalid trans_id
461
# the file is old; the old id is still valid
462
if self._new_root == trans_id:
463
return self._tree.get_root_id()
464
return self._tree.path2id(path)
466
def final_file_id(self, trans_id):
467
"""Determine the file id after any changes are applied, or None.
469
None indicates that the file will not be versioned after changes are
473
return self._new_id[trans_id]
475
if trans_id in self._removed_id:
477
return self.tree_file_id(trans_id)
479
def inactive_file_id(self, trans_id):
480
"""Return the inactive file_id associated with a transaction id.
481
That is, the one in the tree or in non_present_ids.
482
The file_id may actually be active, too.
484
file_id = self.tree_file_id(trans_id)
485
if file_id is not None:
487
for key, value in self._non_present_ids.iteritems():
488
if value == trans_id:
491
def final_parent(self, trans_id):
492
"""Determine the parent file_id, after any changes are applied.
494
ROOT_PARENT is returned for the tree root.
497
return self._new_parent[trans_id]
499
return self.get_tree_parent(trans_id)
501
def final_name(self, trans_id):
502
"""Determine the final filename, after all changes are applied."""
504
return self._new_name[trans_id]
507
return os.path.basename(self._tree_id_paths[trans_id])
509
raise NoFinalPath(trans_id, self)
512
"""Return a map of parent: children for known parents.
514
Only new paths and parents of tree files with assigned ids are used.
517
items = list(self._new_parent.iteritems())
518
items.extend((t, self.final_parent(t)) for t in
519
self._tree_id_paths.keys())
520
for trans_id, parent_id in items:
521
if parent_id not in by_parent:
522
by_parent[parent_id] = set()
523
by_parent[parent_id].add(trans_id)
526
def path_changed(self, trans_id):
527
"""Return True if a trans_id's path has changed."""
528
return (trans_id in self._new_name) or (trans_id in self._new_parent)
530
def new_contents(self, trans_id):
531
return (trans_id in self._new_contents)
533
def find_conflicts(self):
534
"""Find any violations of inventory or filesystem invariants"""
535
if self._done is True:
536
raise ReusingTransform()
538
# ensure all children of all existent parents are known
539
# all children of non-existent parents are known, by definition.
540
self._add_tree_children()
541
by_parent = self.by_parent()
542
conflicts.extend(self._unversioned_parents(by_parent))
543
conflicts.extend(self._parent_loops())
544
conflicts.extend(self._duplicate_entries(by_parent))
545
conflicts.extend(self._duplicate_ids())
546
conflicts.extend(self._parent_type_conflicts(by_parent))
547
conflicts.extend(self._improper_versioning())
548
conflicts.extend(self._executability_conflicts())
549
conflicts.extend(self._overwrite_conflicts())
552
def _check_malformed(self):
553
conflicts = self.find_conflicts()
554
if len(conflicts) != 0:
555
raise MalformedTransform(conflicts=conflicts)
557
def _add_tree_children(self):
558
"""Add all the children of all active parents to the known paths.
560
Active parents are those which gain children, and those which are
561
removed. This is a necessary first step in detecting conflicts.
563
parents = self.by_parent().keys()
564
parents.extend([t for t in self._removed_contents if
565
self.tree_kind(t) == 'directory'])
566
for trans_id in self._removed_id:
567
file_id = self.tree_file_id(trans_id)
568
if file_id is not None:
569
if self._tree.stored_kind(file_id) == 'directory':
570
parents.append(trans_id)
571
elif self.tree_kind(trans_id) == 'directory':
572
parents.append(trans_id)
574
for parent_id in parents:
575
# ensure that all children are registered with the transaction
576
list(self.iter_tree_children(parent_id))
578
@deprecated_method(deprecated_in((2, 3, 0)))
579
def has_named_child(self, by_parent, parent_id, name):
580
return self._has_named_child(
581
name, parent_id, known_children=by_parent.get(parent_id, []))
583
def _has_named_child(self, name, parent_id, known_children):
584
"""Does a parent already have a name child.
586
:param name: The searched for name.
588
:param parent_id: The parent for which the check is made.
590
:param known_children: The already known children. This should have
591
been recently obtained from `self.by_parent.get(parent_id)`
592
(or will be if None is passed).
594
if known_children is None:
595
known_children = self.by_parent().get(parent_id, [])
596
for child in known_children:
597
if self.final_name(child) == name:
599
parent_path = self._tree_id_paths.get(parent_id, None)
600
if parent_path is None:
601
# No parent... no children
603
child_path = joinpath(parent_path, name)
604
child_id = self._tree_path_ids.get(child_path, None)
606
# Not known by the tree transform yet, check the filesystem
607
return osutils.lexists(self._tree.abspath(child_path))
609
raise AssertionError('child_id is missing: %s, %s, %s'
610
% (name, parent_id, child_id))
612
def _available_backup_name(self, name, target_id):
613
"""Find an available backup name.
615
:param name: The basename of the file.
617
:param target_id: The directory trans_id where the backup should
620
known_children = self.by_parent().get(target_id, [])
621
return osutils.available_backup_name(
623
lambda base: self._has_named_child(
624
base, target_id, known_children))
626
def _parent_loops(self):
627
"""No entry should be its own ancestor"""
629
for trans_id in self._new_parent:
632
while parent_id != ROOT_PARENT:
635
parent_id = self.final_parent(parent_id)
638
if parent_id == trans_id:
639
conflicts.append(('parent loop', trans_id))
640
if parent_id in seen:
644
def _unversioned_parents(self, by_parent):
645
"""If parent directories are versioned, children must be versioned."""
647
for parent_id, children in by_parent.iteritems():
648
if parent_id == ROOT_PARENT:
650
if self.final_file_id(parent_id) is not None:
652
for child_id in children:
653
if self.final_file_id(child_id) is not None:
654
conflicts.append(('unversioned parent', parent_id))
658
def _improper_versioning(self):
659
"""Cannot version a file with no contents, or a bad type.
661
However, existing entries with no contents are okay.
664
for trans_id in self._new_id.iterkeys():
665
kind = self.final_kind(trans_id)
667
conflicts.append(('versioning no contents', trans_id))
669
if not inventory.InventoryEntry.versionable_kind(kind):
670
conflicts.append(('versioning bad kind', trans_id, kind))
673
def _executability_conflicts(self):
674
"""Check for bad executability changes.
676
Only versioned files may have their executability set, because
677
1. only versioned entries can have executability under windows
678
2. only files can be executable. (The execute bit on a directory
679
does not indicate searchability)
682
for trans_id in self._new_executability:
683
if self.final_file_id(trans_id) is None:
684
conflicts.append(('unversioned executability', trans_id))
686
if self.final_kind(trans_id) != "file":
687
conflicts.append(('non-file executability', trans_id))
690
def _overwrite_conflicts(self):
691
"""Check for overwrites (not permitted on Win32)"""
693
for trans_id in self._new_contents:
694
if self.tree_kind(trans_id) is None:
696
if trans_id not in self._removed_contents:
697
conflicts.append(('overwrite', trans_id,
698
self.final_name(trans_id)))
701
def _duplicate_entries(self, by_parent):
702
"""No directory may have two entries with the same name."""
704
if (self._new_name, self._new_parent) == ({}, {}):
706
for children in by_parent.itervalues():
708
for child_tid in children:
709
name = self.final_name(child_tid)
711
# Keep children only if they still exist in the end
712
if not self._case_sensitive_target:
714
name_ids.append((name, child_tid))
718
for name, trans_id in name_ids:
719
kind = self.final_kind(trans_id)
720
file_id = self.final_file_id(trans_id)
721
if kind is None and file_id is None:
723
if name == last_name:
724
conflicts.append(('duplicate', last_trans_id, trans_id,
727
last_trans_id = trans_id
730
def _duplicate_ids(self):
731
"""Each inventory id may only be used once"""
733
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
735
all_ids = self._tree.all_file_ids()
736
active_tree_ids = all_ids.difference(removed_tree_ids)
737
for trans_id, file_id in self._new_id.iteritems():
738
if file_id in active_tree_ids:
739
old_trans_id = self.trans_id_tree_file_id(file_id)
740
conflicts.append(('duplicate id', old_trans_id, trans_id))
743
def _parent_type_conflicts(self, by_parent):
744
"""Children must have a directory parent"""
746
for parent_id, children in by_parent.iteritems():
747
if parent_id == ROOT_PARENT:
750
for child_id in children:
751
if self.final_kind(child_id) is not None:
756
# There is at least a child, so we need an existing directory to
758
kind = self.final_kind(parent_id)
760
# The directory will be deleted
761
conflicts.append(('missing parent', parent_id))
762
elif kind != "directory":
763
# Meh, we need a *directory* to put something in it
764
conflicts.append(('non-directory parent', parent_id))
767
def _set_executability(self, path, trans_id):
768
"""Set the executability of versioned files """
769
if self._tree._supports_executable():
770
new_executability = self._new_executability[trans_id]
771
abspath = self._tree.abspath(path)
772
current_mode = os.stat(abspath).st_mode
773
if new_executability:
776
to_mode = current_mode | (0100 & ~umask)
777
# Enable x-bit for others only if they can read it.
778
if current_mode & 0004:
779
to_mode |= 0001 & ~umask
780
if current_mode & 0040:
781
to_mode |= 0010 & ~umask
783
to_mode = current_mode & ~0111
784
osutils.chmod_if_possible(abspath, to_mode)
786
def _new_entry(self, name, parent_id, file_id):
787
"""Helper function to create a new filesystem entry."""
788
trans_id = self.create_path(name, parent_id)
789
if file_id is not None:
790
self.version_file(file_id, trans_id)
793
def new_file(self, name, parent_id, contents, file_id=None,
794
executable=None, sha1=None):
795
"""Convenience method to create files.
797
name is the name of the file to create.
798
parent_id is the transaction id of the parent directory of the file.
799
contents is an iterator of bytestrings, which will be used to produce
801
:param file_id: The inventory ID of the file, if it is to be versioned.
802
:param executable: Only valid when a file_id has been supplied.
804
trans_id = self._new_entry(name, parent_id, file_id)
805
# TODO: rather than scheduling a set_executable call,
806
# have create_file create the file with the right mode.
807
self.create_file(contents, trans_id, sha1=sha1)
808
if executable is not None:
809
self.set_executability(executable, trans_id)
812
def new_directory(self, name, parent_id, file_id=None):
813
"""Convenience method to create directories.
815
name is the name of the directory to create.
816
parent_id is the transaction id of the parent directory of the
818
file_id is the inventory ID of the directory, if it is to be versioned.
820
trans_id = self._new_entry(name, parent_id, file_id)
821
self.create_directory(trans_id)
824
def new_symlink(self, name, parent_id, target, file_id=None):
825
"""Convenience method to create symbolic link.
827
name is the name of the symlink to create.
828
parent_id is the transaction id of the parent directory of the symlink.
829
target is a bytestring of the target of the symlink.
830
file_id is the inventory ID of the file, if it is to be versioned.
832
trans_id = self._new_entry(name, parent_id, file_id)
833
self.create_symlink(target, trans_id)
836
def new_orphan(self, trans_id, parent_id):
837
"""Schedule an item to be orphaned.
839
When a directory is about to be removed, its children, if they are not
840
versioned are moved out of the way: they don't have a parent anymore.
842
:param trans_id: The trans_id of the existing item.
843
:param parent_id: The parent trans_id of the item.
845
raise NotImplementedError(self.new_orphan)
847
def _get_potential_orphans(self, dir_id):
848
"""Find the potential orphans in a directory.
850
A directory can't be safely deleted if there are versioned files in it.
851
If all the contained files are unversioned then they can be orphaned.
853
The 'None' return value means that the directory contains at least one
854
versioned file and should not be deleted.
856
:param dir_id: The directory trans id.
858
:return: A list of the orphan trans ids or None if at least one
859
versioned file is present.
862
# Find the potential orphans, stop if one item should be kept
863
for child_tid in self.by_parent()[dir_id]:
864
if child_tid in self._removed_contents:
865
# The child is removed as part of the transform. Since it was
866
# versioned before, it's not an orphan
868
elif self.final_file_id(child_tid) is None:
869
# The child is not versioned
870
orphans.append(child_tid)
872
# We have a versioned file here, searching for orphans is
878
def _affected_ids(self):
879
"""Return the set of transform ids affected by the transform"""
880
trans_ids = set(self._removed_id)
881
trans_ids.update(self._new_id.keys())
882
trans_ids.update(self._removed_contents)
883
trans_ids.update(self._new_contents.keys())
884
trans_ids.update(self._new_executability.keys())
885
trans_ids.update(self._new_name.keys())
886
trans_ids.update(self._new_parent.keys())
889
def _get_file_id_maps(self):
890
"""Return mapping of file_ids to trans_ids in the to and from states"""
891
trans_ids = self._affected_ids()
894
# Build up two dicts: trans_ids associated with file ids in the
895
# FROM state, vs the TO state.
896
for trans_id in trans_ids:
897
from_file_id = self.tree_file_id(trans_id)
898
if from_file_id is not None:
899
from_trans_ids[from_file_id] = trans_id
900
to_file_id = self.final_file_id(trans_id)
901
if to_file_id is not None:
902
to_trans_ids[to_file_id] = trans_id
903
return from_trans_ids, to_trans_ids
905
def _from_file_data(self, from_trans_id, from_versioned, file_id):
906
"""Get data about a file in the from (tree) state
908
Return a (name, parent, kind, executable) tuple
910
from_path = self._tree_id_paths.get(from_trans_id)
912
# get data from working tree if versioned
913
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
914
from_name = from_entry.name
915
from_parent = from_entry.parent_id
918
if from_path is None:
919
# File does not exist in FROM state
923
# File exists, but is not versioned. Have to use path-
925
from_name = os.path.basename(from_path)
926
tree_parent = self.get_tree_parent(from_trans_id)
927
from_parent = self.tree_file_id(tree_parent)
928
if from_path is not None:
929
from_kind, from_executable, from_stats = \
930
self._tree._comparison_data(from_entry, from_path)
933
from_executable = False
934
return from_name, from_parent, from_kind, from_executable
936
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
937
"""Get data about a file in the to (target) state
939
Return a (name, parent, kind, executable) tuple
941
to_name = self.final_name(to_trans_id)
942
to_kind = self.final_kind(to_trans_id)
943
to_parent = self.final_file_id(self.final_parent(to_trans_id))
944
if to_trans_id in self._new_executability:
945
to_executable = self._new_executability[to_trans_id]
946
elif to_trans_id == from_trans_id:
947
to_executable = from_executable
949
to_executable = False
950
return to_name, to_parent, to_kind, to_executable
952
def iter_changes(self):
953
"""Produce output in the same format as Tree.iter_changes.
955
Will produce nonsensical results if invoked while inventory/filesystem
956
conflicts (as reported by TreeTransform.find_conflicts()) are present.
958
This reads the Transform, but only reproduces changes involving a
959
file_id. Files that are not versioned in either of the FROM or TO
960
states are not reflected.
962
final_paths = FinalPaths(self)
963
from_trans_ids, to_trans_ids = self._get_file_id_maps()
965
# Now iterate through all active file_ids
966
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
968
from_trans_id = from_trans_ids.get(file_id)
969
# find file ids, and determine versioning state
970
if from_trans_id is None:
971
from_versioned = False
972
from_trans_id = to_trans_ids[file_id]
974
from_versioned = True
975
to_trans_id = to_trans_ids.get(file_id)
976
if to_trans_id is None:
978
to_trans_id = from_trans_id
982
from_name, from_parent, from_kind, from_executable = \
983
self._from_file_data(from_trans_id, from_versioned, file_id)
985
to_name, to_parent, to_kind, to_executable = \
986
self._to_file_data(to_trans_id, from_trans_id, from_executable)
988
if not from_versioned:
991
from_path = self._tree_id_paths.get(from_trans_id)
995
to_path = final_paths.get_path(to_trans_id)
996
if from_kind != to_kind:
998
elif to_kind in ('file', 'symlink') and (
999
to_trans_id != from_trans_id or
1000
to_trans_id in self._new_contents):
1002
if (not modified and from_versioned == to_versioned and
1003
from_parent==to_parent and from_name == to_name and
1004
from_executable == to_executable):
1006
results.append((file_id, (from_path, to_path), modified,
1007
(from_versioned, to_versioned),
1008
(from_parent, to_parent),
1009
(from_name, to_name),
1010
(from_kind, to_kind),
1011
(from_executable, to_executable)))
1012
return iter(sorted(results, key=lambda x:x[1]))
1014
def get_preview_tree(self):
1015
"""Return a tree representing the result of the transform.
1017
The tree is a snapshot, and altering the TreeTransform will invalidate
1020
return _PreviewTree(self)
1022
def commit(self, branch, message, merge_parents=None, strict=False,
1023
timestamp=None, timezone=None, committer=None, authors=None,
1024
revprops=None, revision_id=None):
1025
"""Commit the result of this TreeTransform to a branch.
1027
:param branch: The branch to commit to.
1028
:param message: The message to attach to the commit.
1029
:param merge_parents: Additional parent revision-ids specified by
1031
:param strict: If True, abort the commit if there are unversioned
1033
:param timestamp: if not None, seconds-since-epoch for the time and
1034
date. (May be a float.)
1035
:param timezone: Optional timezone for timestamp, as an offset in
1037
:param committer: Optional committer in email-id format.
1038
(e.g. "J Random Hacker <jrandom@example.com>")
1039
:param authors: Optional list of authors in email-id format.
1040
:param revprops: Optional dictionary of revision properties.
1041
:param revision_id: Optional revision id. (Specifying a revision-id
1042
may reduce performance for some non-native formats.)
1043
:return: The revision_id of the revision committed.
1045
self._check_malformed()
1047
unversioned = set(self._new_contents).difference(set(self._new_id))
1048
for trans_id in unversioned:
1049
if self.final_file_id(trans_id) is None:
1050
raise errors.StrictCommitFailed()
1052
revno, last_rev_id = branch.last_revision_info()
1053
if last_rev_id == _mod_revision.NULL_REVISION:
1054
if merge_parents is not None:
1055
raise ValueError('Cannot supply merge parents for first'
1059
parent_ids = [last_rev_id]
1060
if merge_parents is not None:
1061
parent_ids.extend(merge_parents)
1062
if self._tree.get_revision_id() != last_rev_id:
1063
raise ValueError('TreeTransform not based on branch basis: %s' %
1064
self._tree.get_revision_id())
1065
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1066
builder = branch.get_commit_builder(parent_ids,
1067
timestamp=timestamp,
1069
committer=committer,
1071
revision_id=revision_id)
1072
preview = self.get_preview_tree()
1073
list(builder.record_iter_changes(preview, last_rev_id,
1074
self.iter_changes()))
1075
builder.finish_inventory()
1076
revision_id = builder.commit(message)
1077
branch.set_last_revision_info(revno + 1, revision_id)
1080
def _text_parent(self, trans_id):
1081
file_id = self.tree_file_id(trans_id)
1083
if file_id is None or self._tree.kind(file_id) != 'file':
1085
except errors.NoSuchFile:
1089
def _get_parents_texts(self, trans_id):
1090
"""Get texts for compression parents of this file."""
1091
file_id = self._text_parent(trans_id)
1094
return (self._tree.get_file_text(file_id),)
1096
def _get_parents_lines(self, trans_id):
1097
"""Get lines for compression parents of this file."""
1098
file_id = self._text_parent(trans_id)
1101
return (self._tree.get_file_lines(file_id),)
1103
def serialize(self, serializer):
1104
"""Serialize this TreeTransform.
1106
:param serializer: A Serialiser like pack.ContainerSerializer.
1108
new_name = dict((k, v.encode('utf-8')) for k, v in
1109
self._new_name.items())
1110
new_executability = dict((k, int(v)) for k, v in
1111
self._new_executability.items())
1112
tree_path_ids = dict((k.encode('utf-8'), v)
1113
for k, v in self._tree_path_ids.items())
1115
'_id_number': self._id_number,
1116
'_new_name': new_name,
1117
'_new_parent': self._new_parent,
1118
'_new_executability': new_executability,
1119
'_new_id': self._new_id,
1120
'_tree_path_ids': tree_path_ids,
1121
'_removed_id': list(self._removed_id),
1122
'_removed_contents': list(self._removed_contents),
1123
'_non_present_ids': self._non_present_ids,
1125
yield serializer.bytes_record(bencode.bencode(attribs),
1127
for trans_id, kind in self._new_contents.items():
1129
lines = osutils.chunks_to_lines(
1130
self._read_file_chunks(trans_id))
1131
parents = self._get_parents_lines(trans_id)
1132
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1133
content = ''.join(mpdiff.to_patch())
1134
if kind == 'directory':
1136
if kind == 'symlink':
1137
content = self._read_symlink_target(trans_id)
1138
yield serializer.bytes_record(content, ((trans_id, kind),))
1140
def deserialize(self, records):
1141
"""Deserialize a stored TreeTransform.
1143
:param records: An iterable of (names, content) tuples, as per
1144
pack.ContainerPushParser.
1146
names, content = records.next()
1147
attribs = bencode.bdecode(content)
1148
self._id_number = attribs['_id_number']
1149
self._new_name = dict((k, v.decode('utf-8'))
1150
for k, v in attribs['_new_name'].items())
1151
self._new_parent = attribs['_new_parent']
1152
self._new_executability = dict((k, bool(v)) for k, v in
1153
attribs['_new_executability'].items())
1154
self._new_id = attribs['_new_id']
1155
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1156
self._tree_path_ids = {}
1157
self._tree_id_paths = {}
1158
for bytepath, trans_id in attribs['_tree_path_ids'].items():
1159
path = bytepath.decode('utf-8')
1160
self._tree_path_ids[path] = trans_id
1161
self._tree_id_paths[trans_id] = path
1162
self._removed_id = set(attribs['_removed_id'])
1163
self._removed_contents = set(attribs['_removed_contents'])
1164
self._non_present_ids = attribs['_non_present_ids']
1165
for ((trans_id, kind),), content in records:
1167
mpdiff = multiparent.MultiParent.from_patch(content)
1168
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1169
self.create_file(lines, trans_id)
1170
if kind == 'directory':
1171
self.create_directory(trans_id)
1172
if kind == 'symlink':
1173
self.create_symlink(content.decode('utf-8'), trans_id)
1176
class DiskTreeTransform(TreeTransformBase):
1177
"""Tree transform storing its contents on disk."""
1179
def __init__(self, tree, limbodir, pb=None,
1180
case_sensitive=True):
1182
:param tree: The tree that will be transformed, but not necessarily
1184
:param limbodir: A directory where new files can be stored until
1185
they are installed in their proper places
1187
:param case_sensitive: If True, the target of the transform is
1188
case sensitive, not just case preserving.
1190
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1191
self._limbodir = limbodir
1192
self._deletiondir = None
1193
# A mapping of transform ids to their limbo filename
1194
self._limbo_files = {}
1195
self._possibly_stale_limbo_files = set()
1196
# A mapping of transform ids to a set of the transform ids of children
1197
# that their limbo directory has
1198
self._limbo_children = {}
1199
# Map transform ids to maps of child filename to child transform id
1200
self._limbo_children_names = {}
1201
# List of transform ids that need to be renamed from limbo into place
1202
self._needs_rename = set()
1203
self._creation_mtime = None
1206
"""Release the working tree lock, if held, clean up limbo dir.
1208
This is required if apply has not been invoked, but can be invoked
1211
if self._tree is None:
1214
limbo_paths = self._limbo_files.values() + list(
1215
self._possibly_stale_limbo_files)
1216
limbo_paths = sorted(limbo_paths, reverse=True)
1217
for path in limbo_paths:
1221
if e.errno != errno.ENOENT:
1223
# XXX: warn? perhaps we just got interrupted at an
1224
# inconvenient moment, but perhaps files are disappearing
1227
delete_any(self._limbodir)
1229
# We don't especially care *why* the dir is immortal.
1230
raise ImmortalLimbo(self._limbodir)
1232
if self._deletiondir is not None:
1233
delete_any(self._deletiondir)
1235
raise errors.ImmortalPendingDeletion(self._deletiondir)
1237
TreeTransformBase.finalize(self)
1239
def _limbo_supports_executable(self):
1240
"""Check if the limbo path supports the executable bit."""
1241
# FIXME: Check actual file system capabilities of limbodir
1242
return osutils.supports_executable()
1244
def _limbo_name(self, trans_id):
1245
"""Generate the limbo name of a file"""
1246
limbo_name = self._limbo_files.get(trans_id)
1247
if limbo_name is None:
1248
limbo_name = self._generate_limbo_path(trans_id)
1249
self._limbo_files[trans_id] = limbo_name
1252
def _generate_limbo_path(self, trans_id):
1253
"""Generate a limbo path using the trans_id as the relative path.
1255
This is suitable as a fallback, and when the transform should not be
1256
sensitive to the path encoding of the limbo directory.
1258
self._needs_rename.add(trans_id)
1259
return pathjoin(self._limbodir, trans_id)
1261
def adjust_path(self, name, parent, trans_id):
1262
previous_parent = self._new_parent.get(trans_id)
1263
previous_name = self._new_name.get(trans_id)
1264
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1265
if (trans_id in self._limbo_files and
1266
trans_id not in self._needs_rename):
1267
self._rename_in_limbo([trans_id])
1268
if previous_parent != parent:
1269
self._limbo_children[previous_parent].remove(trans_id)
1270
if previous_parent != parent or previous_name != name:
1271
del self._limbo_children_names[previous_parent][previous_name]
1273
def _rename_in_limbo(self, trans_ids):
1274
"""Fix limbo names so that the right final path is produced.
1276
This means we outsmarted ourselves-- we tried to avoid renaming
1277
these files later by creating them with their final names in their
1278
final parents. But now the previous name or parent is no longer
1279
suitable, so we have to rename them.
1281
Even for trans_ids that have no new contents, we must remove their
1282
entries from _limbo_files, because they are now stale.
1284
for trans_id in trans_ids:
1285
old_path = self._limbo_files[trans_id]
1286
self._possibly_stale_limbo_files.add(old_path)
1287
del self._limbo_files[trans_id]
1288
if trans_id not in self._new_contents:
1290
new_path = self._limbo_name(trans_id)
1291
os.rename(old_path, new_path)
1292
self._possibly_stale_limbo_files.remove(old_path)
1293
for descendant in self._limbo_descendants(trans_id):
1294
desc_path = self._limbo_files[descendant]
1295
desc_path = new_path + desc_path[len(old_path):]
1296
self._limbo_files[descendant] = desc_path
1298
def _limbo_descendants(self, trans_id):
1299
"""Return the set of trans_ids whose limbo paths descend from this."""
1300
descendants = set(self._limbo_children.get(trans_id, []))
1301
for descendant in list(descendants):
1302
descendants.update(self._limbo_descendants(descendant))
1305
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1306
"""Schedule creation of a new file.
1310
:param contents: an iterator of strings, all of which will be written
1311
to the target destination.
1312
:param trans_id: TreeTransform handle
1313
:param mode_id: If not None, force the mode of the target file to match
1314
the mode of the object referenced by mode_id.
1315
Otherwise, we will try to preserve mode bits of an existing file.
1316
:param sha1: If the sha1 of this content is already known, pass it in.
1317
We can use it to prevent future sha1 computations.
1319
name = self._limbo_name(trans_id)
1320
f = open(name, 'wb')
1322
unique_add(self._new_contents, trans_id, 'file')
1323
f.writelines(contents)
1326
self._set_mtime(name)
1327
self._set_mode(trans_id, mode_id, S_ISREG)
1328
# It is unfortunate we have to use lstat instead of fstat, but we just
1329
# used utime and chmod on the file, so we need the accurate final
1331
if sha1 is not None:
1332
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1334
def _read_file_chunks(self, trans_id):
1335
cur_file = open(self._limbo_name(trans_id), 'rb')
1337
return cur_file.readlines()
1341
def _read_symlink_target(self, trans_id):
1342
return os.readlink(self._limbo_name(trans_id))
1344
def _set_mtime(self, path):
1345
"""All files that are created get the same mtime.
1347
This time is set by the first object to be created.
1349
if self._creation_mtime is None:
1350
self._creation_mtime = time.time()
1351
os.utime(path, (self._creation_mtime, self._creation_mtime))
1353
def create_hardlink(self, path, trans_id):
1354
"""Schedule creation of a hard link"""
1355
name = self._limbo_name(trans_id)
1359
if e.errno != errno.EPERM:
1361
raise errors.HardLinkNotSupported(path)
1363
unique_add(self._new_contents, trans_id, 'file')
1365
# Clean up the file, it never got registered so
1366
# TreeTransform.finalize() won't clean it up.
1370
def create_directory(self, trans_id):
1371
"""Schedule creation of a new directory.
1373
See also new_directory.
1375
os.mkdir(self._limbo_name(trans_id))
1376
unique_add(self._new_contents, trans_id, 'directory')
1378
def create_symlink(self, target, trans_id):
1379
"""Schedule creation of a new symbolic link.
1381
target is a bytestring.
1382
See also new_symlink.
1385
os.symlink(target, self._limbo_name(trans_id))
1386
unique_add(self._new_contents, trans_id, 'symlink')
1389
path = FinalPaths(self).get_path(trans_id)
1392
raise UnableCreateSymlink(path=path)
1394
def cancel_creation(self, trans_id):
1395
"""Cancel the creation of new file contents."""
1396
del self._new_contents[trans_id]
1397
if trans_id in self._observed_sha1s:
1398
del self._observed_sha1s[trans_id]
1399
children = self._limbo_children.get(trans_id)
1400
# if this is a limbo directory with children, move them before removing
1402
if children is not None:
1403
self._rename_in_limbo(children)
1404
del self._limbo_children[trans_id]
1405
del self._limbo_children_names[trans_id]
1406
delete_any(self._limbo_name(trans_id))
1408
def new_orphan(self, trans_id, parent_id):
1409
conf = self._tree.get_config_stack()
1410
handle_orphan = conf.get('bzr.transform.orphan_policy')
1411
handle_orphan(self, trans_id, parent_id)
1414
class OrphaningError(errors.BzrError):
1416
# Only bugs could lead to such exception being seen by the user
1417
internal_error = True
1418
_fmt = "Error while orphaning %s in %s directory"
1420
def __init__(self, orphan, parent):
1421
errors.BzrError.__init__(self)
1422
self.orphan = orphan
1423
self.parent = parent
1426
class OrphaningForbidden(OrphaningError):
1428
_fmt = "Policy: %s doesn't allow creating orphans."
1430
def __init__(self, policy):
1431
errors.BzrError.__init__(self)
1432
self.policy = policy
1435
def move_orphan(tt, orphan_id, parent_id):
1436
"""See TreeTransformBase.new_orphan.
1438
This creates a new orphan in the `bzr-orphans` dir at the root of the
1441
:param tt: The TreeTransform orphaning `trans_id`.
1443
:param orphan_id: The trans id that should be orphaned.
1445
:param parent_id: The orphan parent trans id.
1447
# Add the orphan dir if it doesn't exist
1448
orphan_dir_basename = 'bzr-orphans'
1449
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1450
if tt.final_kind(od_id) is None:
1451
tt.create_directory(od_id)
1452
parent_path = tt._tree_id_paths[parent_id]
1453
# Find a name that doesn't exist yet in the orphan dir
1454
actual_name = tt.final_name(orphan_id)
1455
new_name = tt._available_backup_name(actual_name, od_id)
1456
tt.adjust_path(new_name, od_id, orphan_id)
1457
trace.warning('%s has been orphaned in %s'
1458
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1461
def refuse_orphan(tt, orphan_id, parent_id):
1462
"""See TreeTransformBase.new_orphan.
1464
This refuses to create orphan, letting the caller handle the conflict.
1466
raise OrphaningForbidden('never')
1469
orphaning_registry = registry.Registry()
1470
orphaning_registry.register(
1471
'conflict', refuse_orphan,
1472
'Leave orphans in place and create a conflict on the directory.')
1473
orphaning_registry.register(
1474
'move', move_orphan,
1475
'Move orphans into the bzr-orphans directory.')
1476
orphaning_registry._set_default_key('conflict')
1479
opt_transform_orphan = _mod_config.RegistryOption(
1480
'bzr.transform.orphan_policy', orphaning_registry,
1481
help='Policy for orphaned files during transform operations.',
1485
class TreeTransform(DiskTreeTransform):
1486
"""Represent a tree transformation.
1488
This object is designed to support incremental generation of the transform,
1491
However, it gives optimum performance when parent directories are created
1492
before their contents. The transform is then able to put child files
1493
directly in their parent directory, avoiding later renames.
1495
It is easy to produce malformed transforms, but they are generally
1496
harmless. Attempting to apply a malformed transform will cause an
1497
exception to be raised before any modifications are made to the tree.
1499
Many kinds of malformed transforms can be corrected with the
1500
resolve_conflicts function. The remaining ones indicate programming error,
1501
such as trying to create a file with no path.
1503
Two sets of file creation methods are supplied. Convenience methods are:
1508
These are composed of the low-level methods:
1510
* create_file or create_directory or create_symlink
1514
Transform/Transaction ids
1515
-------------------------
1516
trans_ids are temporary ids assigned to all files involved in a transform.
1517
It's possible, even common, that not all files in the Tree have trans_ids.
1519
trans_ids are used because filenames and file_ids are not good enough
1520
identifiers; filenames change, and not all files have file_ids. File-ids
1521
are also associated with trans-ids, so that moving a file moves its
1524
trans_ids are only valid for the TreeTransform that generated them.
1528
Limbo is a temporary directory use to hold new versions of files.
1529
Files are added to limbo by create_file, create_directory, create_symlink,
1530
and their convenience variants (new_*). Files may be removed from limbo
1531
using cancel_creation. Files are renamed from limbo into their final
1532
location as part of TreeTransform.apply
1534
Limbo must be cleaned up, by either calling TreeTransform.apply or
1535
calling TreeTransform.finalize.
1537
Files are placed into limbo inside their parent directories, where
1538
possible. This reduces subsequent renames, and makes operations involving
1539
lots of files faster. This optimization is only possible if the parent
1540
directory is created *before* creating any of its children, so avoid
1541
creating children before parents, where possible.
1545
This temporary directory is used by _FileMover for storing files that are
1546
about to be deleted. In case of rollback, the files will be restored.
1547
FileMover does not delete files until it is sure that a rollback will not
1550
def __init__(self, tree, pb=None):
1551
"""Note: a tree_write lock is taken on the tree.
1553
Use TreeTransform.finalize() to release the lock (can be omitted if
1554
TreeTransform.apply() called).
1556
tree.lock_tree_write()
1559
limbodir = urlutils.local_path_from_url(
1560
tree._transport.abspath('limbo'))
1561
osutils.ensure_empty_directory_exists(
1563
errors.ExistingLimbo)
1564
deletiondir = urlutils.local_path_from_url(
1565
tree._transport.abspath('pending-deletion'))
1566
osutils.ensure_empty_directory_exists(
1568
errors.ExistingPendingDeletion)
1573
# Cache of realpath results, to speed up canonical_path
1574
self._realpaths = {}
1575
# Cache of relpath results, to speed up canonical_path
1577
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1578
tree.case_sensitive)
1579
self._deletiondir = deletiondir
1581
def canonical_path(self, path):
1582
"""Get the canonical tree-relative path"""
1583
# don't follow final symlinks
1584
abs = self._tree.abspath(path)
1585
if abs in self._relpaths:
1586
return self._relpaths[abs]
1587
dirname, basename = os.path.split(abs)
1588
if dirname not in self._realpaths:
1589
self._realpaths[dirname] = os.path.realpath(dirname)
1590
dirname = self._realpaths[dirname]
1591
abs = pathjoin(dirname, basename)
1592
if dirname in self._relpaths:
1593
relpath = pathjoin(self._relpaths[dirname], basename)
1594
relpath = relpath.rstrip('/\\')
1596
relpath = self._tree.relpath(abs)
1597
self._relpaths[abs] = relpath
1600
def tree_kind(self, trans_id):
1601
"""Determine the file kind in the working tree.
1603
:returns: The file kind or None if the file does not exist
1605
path = self._tree_id_paths.get(trans_id)
1609
return file_kind(self._tree.abspath(path))
1610
except errors.NoSuchFile:
1613
def _set_mode(self, trans_id, mode_id, typefunc):
1614
"""Set the mode of new file contents.
1615
The mode_id is the existing file to get the mode from (often the same
1616
as trans_id). The operation is only performed if there's a mode match
1617
according to typefunc.
1622
old_path = self._tree_id_paths[mode_id]
1626
mode = os.stat(self._tree.abspath(old_path)).st_mode
1628
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1629
# Either old_path doesn't exist, or the parent of the
1630
# target is not a directory (but will be one eventually)
1631
# Either way, we know it doesn't exist *right now*
1632
# See also bug #248448
1637
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1639
def iter_tree_children(self, parent_id):
1640
"""Iterate through the entry's tree children, if any"""
1642
path = self._tree_id_paths[parent_id]
1646
children = os.listdir(self._tree.abspath(path))
1648
if not (osutils._is_error_enotdir(e)
1649
or e.errno in (errno.ENOENT, errno.ESRCH)):
1653
for child in children:
1654
childpath = joinpath(path, child)
1655
if self._tree.is_control_filename(childpath):
1657
yield self.trans_id_tree_path(childpath)
1659
def _generate_limbo_path(self, trans_id):
1660
"""Generate a limbo path using the final path if possible.
1662
This optimizes the performance of applying the tree transform by
1663
avoiding renames. These renames can be avoided only when the parent
1664
directory is already scheduled for creation.
1666
If the final path cannot be used, falls back to using the trans_id as
1669
parent = self._new_parent.get(trans_id)
1670
# if the parent directory is already in limbo (e.g. when building a
1671
# tree), choose a limbo name inside the parent, to reduce further
1673
use_direct_path = False
1674
if self._new_contents.get(parent) == 'directory':
1675
filename = self._new_name.get(trans_id)
1676
if filename is not None:
1677
if parent not in self._limbo_children:
1678
self._limbo_children[parent] = set()
1679
self._limbo_children_names[parent] = {}
1680
use_direct_path = True
1681
# the direct path can only be used if no other file has
1682
# already taken this pathname, i.e. if the name is unused, or
1683
# if it is already associated with this trans_id.
1684
elif self._case_sensitive_target:
1685
if (self._limbo_children_names[parent].get(filename)
1686
in (trans_id, None)):
1687
use_direct_path = True
1689
for l_filename, l_trans_id in\
1690
self._limbo_children_names[parent].iteritems():
1691
if l_trans_id == trans_id:
1693
if l_filename.lower() == filename.lower():
1696
use_direct_path = True
1698
if not use_direct_path:
1699
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1701
limbo_name = pathjoin(self._limbo_files[parent], filename)
1702
self._limbo_children[parent].add(trans_id)
1703
self._limbo_children_names[parent][filename] = trans_id
1707
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1708
"""Apply all changes to the inventory and filesystem.
1710
If filesystem or inventory conflicts are present, MalformedTransform
1713
If apply succeeds, finalize is not necessary.
1715
:param no_conflicts: if True, the caller guarantees there are no
1716
conflicts, so no check is made.
1717
:param precomputed_delta: An inventory delta to use instead of
1719
:param _mover: Supply an alternate FileMover, for testing
1721
for hook in MutableTree.hooks['pre_transform']:
1722
hook(self._tree, self)
1723
if not no_conflicts:
1724
self._check_malformed()
1725
child_pb = ui.ui_factory.nested_progress_bar()
1727
if precomputed_delta is None:
1728
child_pb.update(gettext('Apply phase'), 0, 2)
1729
inventory_delta = self._generate_inventory_delta()
1732
inventory_delta = precomputed_delta
1735
mover = _FileMover()
1739
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1740
self._apply_removals(mover)
1741
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1742
modified_paths = self._apply_insertions(mover)
1747
mover.apply_deletions()
1750
if self.final_file_id(self.root) is None:
1751
inventory_delta = [e for e in inventory_delta if e[0] != '']
1752
self._tree.apply_inventory_delta(inventory_delta)
1753
self._apply_observed_sha1s()
1756
return _TransformResults(modified_paths, self.rename_count)
1758
def _generate_inventory_delta(self):
1759
"""Generate an inventory delta for the current transform."""
1760
inventory_delta = []
1761
child_pb = ui.ui_factory.nested_progress_bar()
1762
new_paths = self._inventory_altered()
1763
total_entries = len(new_paths) + len(self._removed_id)
1765
for num, trans_id in enumerate(self._removed_id):
1767
child_pb.update(gettext('removing file'), num, total_entries)
1768
if trans_id == self._new_root:
1769
file_id = self._tree.get_root_id()
1771
file_id = self.tree_file_id(trans_id)
1772
# File-id isn't really being deleted, just moved
1773
if file_id in self._r_new_id:
1775
path = self._tree_id_paths[trans_id]
1776
inventory_delta.append((path, None, file_id, None))
1777
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1779
entries = self._tree.iter_entries_by_dir(
1780
new_path_file_ids.values())
1781
old_paths = dict((e.file_id, p) for p, e in entries)
1783
for num, (path, trans_id) in enumerate(new_paths):
1785
child_pb.update(gettext('adding file'),
1786
num + len(self._removed_id), total_entries)
1787
file_id = new_path_file_ids[trans_id]
1791
kind = self.final_kind(trans_id)
1793
kind = self._tree.stored_kind(file_id)
1794
parent_trans_id = self.final_parent(trans_id)
1795
parent_file_id = new_path_file_ids.get(parent_trans_id)
1796
if parent_file_id is None:
1797
parent_file_id = self.final_file_id(parent_trans_id)
1798
if trans_id in self._new_reference_revision:
1799
new_entry = inventory.TreeReference(
1801
self._new_name[trans_id],
1802
self.final_file_id(self._new_parent[trans_id]),
1803
None, self._new_reference_revision[trans_id])
1805
new_entry = inventory.make_entry(kind,
1806
self.final_name(trans_id),
1807
parent_file_id, file_id)
1808
old_path = old_paths.get(new_entry.file_id)
1809
new_executability = self._new_executability.get(trans_id)
1810
if new_executability is not None:
1811
new_entry.executable = new_executability
1812
inventory_delta.append(
1813
(old_path, path, new_entry.file_id, new_entry))
1816
return inventory_delta
1818
def _apply_removals(self, mover):
1819
"""Perform tree operations that remove directory/inventory names.
1821
That is, delete files that are to be deleted, and put any files that
1822
need renaming into limbo. This must be done in strict child-to-parent
1825
If inventory_delta is None, no inventory delta generation is performed.
1827
tree_paths = list(self._tree_path_ids.iteritems())
1828
tree_paths.sort(reverse=True)
1829
child_pb = ui.ui_factory.nested_progress_bar()
1831
for num, (path, trans_id) in enumerate(tree_paths):
1832
# do not attempt to move root into a subdirectory of itself.
1835
child_pb.update(gettext('removing file'), num, len(tree_paths))
1836
full_path = self._tree.abspath(path)
1837
if trans_id in self._removed_contents:
1838
delete_path = os.path.join(self._deletiondir, trans_id)
1839
mover.pre_delete(full_path, delete_path)
1840
elif (trans_id in self._new_name
1841
or trans_id in self._new_parent):
1843
mover.rename(full_path, self._limbo_name(trans_id))
1844
except errors.TransformRenameFailed, e:
1845
if e.errno != errno.ENOENT:
1848
self.rename_count += 1
1852
def _apply_insertions(self, mover):
1853
"""Perform tree operations that insert directory/inventory names.
1855
That is, create any files that need to be created, and restore from
1856
limbo any files that needed renaming. This must be done in strict
1857
parent-to-child order.
1859
If inventory_delta is None, no inventory delta is calculated, and
1860
no list of modified paths is returned.
1862
new_paths = self.new_paths(filesystem_only=True)
1864
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1866
child_pb = ui.ui_factory.nested_progress_bar()
1868
for num, (path, trans_id) in enumerate(new_paths):
1870
child_pb.update(gettext('adding file'), num, len(new_paths))
1871
full_path = self._tree.abspath(path)
1872
if trans_id in self._needs_rename:
1874
mover.rename(self._limbo_name(trans_id), full_path)
1875
except errors.TransformRenameFailed, e:
1876
# We may be renaming a dangling inventory id
1877
if e.errno != errno.ENOENT:
1880
self.rename_count += 1
1881
# TODO: if trans_id in self._observed_sha1s, we should
1882
# re-stat the final target, since ctime will be
1883
# updated by the change.
1884
if (trans_id in self._new_contents or
1885
self.path_changed(trans_id)):
1886
if trans_id in self._new_contents:
1887
modified_paths.append(full_path)
1888
if trans_id in self._new_executability:
1889
self._set_executability(path, trans_id)
1890
if trans_id in self._observed_sha1s:
1891
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1892
st = osutils.lstat(full_path)
1893
self._observed_sha1s[trans_id] = (o_sha1, st)
1896
for path, trans_id in new_paths:
1897
# new_paths includes stuff like workingtree conflicts. Only the
1898
# stuff in new_contents actually comes from limbo.
1899
if trans_id in self._limbo_files:
1900
del self._limbo_files[trans_id]
1901
self._new_contents.clear()
1902
return modified_paths
1904
def _apply_observed_sha1s(self):
1905
"""After we have finished renaming everything, update observed sha1s
1907
This has to be done after self._tree.apply_inventory_delta, otherwise
1908
it doesn't know anything about the files we are updating. Also, we want
1909
to do this as late as possible, so that most entries end up cached.
1911
# TODO: this doesn't update the stat information for directories. So
1912
# the first 'bzr status' will still need to rewrite
1913
# .bzr/checkout/dirstate. However, we at least don't need to
1914
# re-read all of the files.
1915
# TODO: If the operation took a while, we could do a time.sleep(3) here
1916
# to allow the clock to tick over and ensure we won't have any
1917
# problems. (we could observe start time, and finish time, and if
1918
# it is less than eg 10% overhead, add a sleep call.)
1919
paths = FinalPaths(self)
1920
for trans_id, observed in self._observed_sha1s.iteritems():
1921
path = paths.get_path(trans_id)
1922
# We could get the file_id, but dirstate prefers to use the path
1923
# anyway, and it is 'cheaper' to determine.
1924
# file_id = self._new_id[trans_id]
1925
self._tree._observed_sha1(None, path, observed)
1928
class TransformPreview(DiskTreeTransform):
1929
"""A TreeTransform for generating preview trees.
1931
Unlike TreeTransform, this version works when the input tree is a
1932
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1933
unversioned files in the input tree.
1936
def __init__(self, tree, pb=None, case_sensitive=True):
1938
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1939
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1941
def canonical_path(self, path):
1944
def tree_kind(self, trans_id):
1945
path = self._tree_id_paths.get(trans_id)
1948
kind = self._tree.path_content_summary(path)[0]
1949
if kind == 'missing':
1953
def _set_mode(self, trans_id, mode_id, typefunc):
1954
"""Set the mode of new file contents.
1955
The mode_id is the existing file to get the mode from (often the same
1956
as trans_id). The operation is only performed if there's a mode match
1957
according to typefunc.
1959
# is it ok to ignore this? probably
1962
def iter_tree_children(self, parent_id):
1963
"""Iterate through the entry's tree children, if any"""
1965
path = self._tree_id_paths[parent_id]
1968
file_id = self.tree_file_id(parent_id)
1971
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1972
children = getattr(entry, 'children', {})
1973
for child in children:
1974
childpath = joinpath(path, child)
1975
yield self.trans_id_tree_path(childpath)
1977
def new_orphan(self, trans_id, parent_id):
1978
raise NotImplementedError(self.new_orphan)
1981
class _PreviewTree(tree.InventoryTree):
1982
"""Partial implementation of Tree to support show_diff_trees"""
1984
def __init__(self, transform):
1985
self._transform = transform
1986
self._final_paths = FinalPaths(transform)
1987
self.__by_parent = None
1988
self._parent_ids = []
1989
self._all_children_cache = {}
1990
self._path2trans_id_cache = {}
1991
self._final_name_cache = {}
1992
self._iter_changes_cache = dict((c[0], c) for c in
1993
self._transform.iter_changes())
1995
def _content_change(self, file_id):
1996
"""Return True if the content of this file changed"""
1997
changes = self._iter_changes_cache.get(file_id)
1998
# changes[2] is true if the file content changed. See
1999
# InterTree.iter_changes.
2000
return (changes is not None and changes[2])
2002
def _get_repository(self):
2003
repo = getattr(self._transform._tree, '_repository', None)
2005
repo = self._transform._tree.branch.repository
2008
def _iter_parent_trees(self):
2009
for revision_id in self.get_parent_ids():
2011
yield self.revision_tree(revision_id)
2012
except errors.NoSuchRevisionInTree:
2013
yield self._get_repository().revision_tree(revision_id)
2015
def _get_file_revision(self, file_id, vf, tree_revision):
2016
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2017
self._iter_parent_trees()]
2018
vf.add_lines((file_id, tree_revision), parent_keys,
2019
self.get_file_lines(file_id))
2020
repo = self._get_repository()
2021
base_vf = repo.texts
2022
if base_vf not in vf.fallback_versionedfiles:
2023
vf.fallback_versionedfiles.append(base_vf)
2024
return tree_revision
2026
def _stat_limbo_file(self, file_id=None, trans_id=None):
2027
if trans_id is None:
2028
trans_id = self._transform.trans_id_file_id(file_id)
2029
name = self._transform._limbo_name(trans_id)
2030
return os.lstat(name)
2033
def _by_parent(self):
2034
if self.__by_parent is None:
2035
self.__by_parent = self._transform.by_parent()
2036
return self.__by_parent
2038
def _comparison_data(self, entry, path):
2039
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2040
if kind == 'missing':
2044
file_id = self._transform.final_file_id(self._path2trans_id(path))
2045
executable = self.is_executable(file_id, path)
2046
return kind, executable, None
2048
def is_locked(self):
2051
def lock_read(self):
2052
# Perhaps in theory, this should lock the TreeTransform?
2059
@deprecated_method(deprecated_in((2, 5, 0)))
2060
def inventory(self):
2061
"""This Tree does not use inventory as its backing data."""
2062
raise NotImplementedError(_PreviewTree.inventory)
2065
def root_inventory(self):
2066
"""This Tree does not use inventory as its backing data."""
2067
raise NotImplementedError(_PreviewTree.root_inventory)
2069
def get_root_id(self):
2070
return self._transform.final_file_id(self._transform.root)
2072
def all_file_ids(self):
2073
tree_ids = set(self._transform._tree.all_file_ids())
2074
tree_ids.difference_update(self._transform.tree_file_id(t)
2075
for t in self._transform._removed_id)
2076
tree_ids.update(self._transform._new_id.values())
2080
return iter(self.all_file_ids())
2082
def _has_id(self, file_id, fallback_check):
2083
if file_id in self._transform._r_new_id:
2085
elif file_id in set([self._transform.tree_file_id(trans_id) for
2086
trans_id in self._transform._removed_id]):
2089
return fallback_check(file_id)
2091
def has_id(self, file_id):
2092
return self._has_id(file_id, self._transform._tree.has_id)
2094
def has_or_had_id(self, file_id):
2095
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2097
def _path2trans_id(self, path):
2098
# We must not use None here, because that is a valid value to store.
2099
trans_id = self._path2trans_id_cache.get(path, object)
2100
if trans_id is not object:
2102
segments = splitpath(path)
2103
cur_parent = self._transform.root
2104
for cur_segment in segments:
2105
for child in self._all_children(cur_parent):
2106
final_name = self._final_name_cache.get(child)
2107
if final_name is None:
2108
final_name = self._transform.final_name(child)
2109
self._final_name_cache[child] = final_name
2110
if final_name == cur_segment:
2114
self._path2trans_id_cache[path] = None
2116
self._path2trans_id_cache[path] = cur_parent
2119
def path2id(self, path):
2120
if isinstance(path, list):
2123
path = osutils.pathjoin(*path)
2124
return self._transform.final_file_id(self._path2trans_id(path))
2126
def id2path(self, file_id):
2127
trans_id = self._transform.trans_id_file_id(file_id)
2129
return self._final_paths._determine_path(trans_id)
2131
raise errors.NoSuchId(self, file_id)
2133
def _all_children(self, trans_id):
2134
children = self._all_children_cache.get(trans_id)
2135
if children is not None:
2137
children = set(self._transform.iter_tree_children(trans_id))
2138
# children in the _new_parent set are provided by _by_parent.
2139
children.difference_update(self._transform._new_parent.keys())
2140
children.update(self._by_parent.get(trans_id, []))
2141
self._all_children_cache[trans_id] = children
2144
def iter_children(self, file_id):
2145
trans_id = self._transform.trans_id_file_id(file_id)
2146
for child_trans_id in self._all_children(trans_id):
2147
yield self._transform.final_file_id(child_trans_id)
2150
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2151
in self._transform._tree.extras())
2152
possible_extras.update(self._transform._new_contents)
2153
possible_extras.update(self._transform._removed_id)
2154
for trans_id in possible_extras:
2155
if self._transform.final_file_id(trans_id) is None:
2156
yield self._final_paths._determine_path(trans_id)
2158
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2159
yield_parents=False):
2160
for trans_id, parent_file_id in ordered_entries:
2161
file_id = self._transform.final_file_id(trans_id)
2164
if (specific_file_ids is not None
2165
and file_id not in specific_file_ids):
2167
kind = self._transform.final_kind(trans_id)
2169
kind = self._transform._tree.stored_kind(file_id)
2170
new_entry = inventory.make_entry(
2172
self._transform.final_name(trans_id),
2173
parent_file_id, file_id)
2174
yield new_entry, trans_id
2176
def _list_files_by_dir(self):
2177
todo = [ROOT_PARENT]
2179
while len(todo) > 0:
2181
parent_file_id = self._transform.final_file_id(parent)
2182
children = list(self._all_children(parent))
2183
paths = dict(zip(children, self._final_paths.get_paths(children)))
2184
children.sort(key=paths.get)
2185
todo.extend(reversed(children))
2186
for trans_id in children:
2187
ordered_ids.append((trans_id, parent_file_id))
2190
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2191
# This may not be a maximally efficient implementation, but it is
2192
# reasonably straightforward. An implementation that grafts the
2193
# TreeTransform changes onto the tree's iter_entries_by_dir results
2194
# might be more efficient, but requires tricky inferences about stack
2196
ordered_ids = self._list_files_by_dir()
2197
for entry, trans_id in self._make_inv_entries(ordered_ids,
2198
specific_file_ids, yield_parents=yield_parents):
2199
yield unicode(self._final_paths.get_path(trans_id)), entry
2201
def _iter_entries_for_dir(self, dir_path):
2202
"""Return path, entry for items in a directory without recursing down."""
2203
dir_file_id = self.path2id(dir_path)
2205
for file_id in self.iter_children(dir_file_id):
2206
trans_id = self._transform.trans_id_file_id(file_id)
2207
ordered_ids.append((trans_id, file_id))
2208
for entry, trans_id in self._make_inv_entries(ordered_ids):
2209
yield unicode(self._final_paths.get_path(trans_id)), entry
2211
def list_files(self, include_root=False, from_dir=None, recursive=True):
2212
"""See WorkingTree.list_files."""
2213
# XXX This should behave like WorkingTree.list_files, but is really
2214
# more like RevisionTree.list_files.
2218
prefix = from_dir + '/'
2219
entries = self.iter_entries_by_dir()
2220
for path, entry in entries:
2221
if entry.name == '' and not include_root:
2224
if not path.startswith(prefix):
2226
path = path[len(prefix):]
2227
yield path, 'V', entry.kind, entry.file_id, entry
2229
if from_dir is None and include_root is True:
2230
root_entry = inventory.make_entry('directory', '',
2231
ROOT_PARENT, self.get_root_id())
2232
yield '', 'V', 'directory', root_entry.file_id, root_entry
2233
entries = self._iter_entries_for_dir(from_dir or '')
2234
for path, entry in entries:
2235
yield path, 'V', entry.kind, entry.file_id, entry
2237
def kind(self, file_id):
2238
trans_id = self._transform.trans_id_file_id(file_id)
2239
return self._transform.final_kind(trans_id)
2241
def stored_kind(self, file_id):
2242
trans_id = self._transform.trans_id_file_id(file_id)
2244
return self._transform._new_contents[trans_id]
2246
return self._transform._tree.stored_kind(file_id)
2248
def get_file_mtime(self, file_id, path=None):
2249
"""See Tree.get_file_mtime"""
2250
if not self._content_change(file_id):
2251
return self._transform._tree.get_file_mtime(file_id)
2252
return self._stat_limbo_file(file_id).st_mtime
2254
def _file_size(self, entry, stat_value):
2255
return self.get_file_size(entry.file_id)
2257
def get_file_size(self, file_id):
2258
"""See Tree.get_file_size"""
2259
trans_id = self._transform.trans_id_file_id(file_id)
2260
kind = self._transform.final_kind(trans_id)
2263
if trans_id in self._transform._new_contents:
2264
return self._stat_limbo_file(trans_id=trans_id).st_size
2265
if self.kind(file_id) == 'file':
2266
return self._transform._tree.get_file_size(file_id)
2270
def get_file_verifier(self, file_id, path=None, stat_value=None):
2271
trans_id = self._transform.trans_id_file_id(file_id)
2272
kind = self._transform._new_contents.get(trans_id)
2274
return self._transform._tree.get_file_verifier(file_id)
2276
fileobj = self.get_file(file_id)
2278
return ("SHA1", sha_file(fileobj))
2282
def get_file_sha1(self, file_id, path=None, stat_value=None):
2283
trans_id = self._transform.trans_id_file_id(file_id)
2284
kind = self._transform._new_contents.get(trans_id)
2286
return self._transform._tree.get_file_sha1(file_id)
2288
fileobj = self.get_file(file_id)
2290
return sha_file(fileobj)
2294
def is_executable(self, file_id, path=None):
2297
trans_id = self._transform.trans_id_file_id(file_id)
2299
return self._transform._new_executability[trans_id]
2302
return self._transform._tree.is_executable(file_id, path)
2304
if e.errno == errno.ENOENT:
2307
except errors.NoSuchId:
2310
def has_filename(self, path):
2311
trans_id = self._path2trans_id(path)
2312
if trans_id in self._transform._new_contents:
2314
elif trans_id in self._transform._removed_contents:
2317
return self._transform._tree.has_filename(path)
2319
def path_content_summary(self, path):
2320
trans_id = self._path2trans_id(path)
2321
tt = self._transform
2322
tree_path = tt._tree_id_paths.get(trans_id)
2323
kind = tt._new_contents.get(trans_id)
2325
if tree_path is None or trans_id in tt._removed_contents:
2326
return 'missing', None, None, None
2327
summary = tt._tree.path_content_summary(tree_path)
2328
kind, size, executable, link_or_sha1 = summary
2331
limbo_name = tt._limbo_name(trans_id)
2332
if trans_id in tt._new_reference_revision:
2333
kind = 'tree-reference'
2335
statval = os.lstat(limbo_name)
2336
size = statval.st_size
2337
if not tt._limbo_supports_executable():
2340
executable = statval.st_mode & S_IEXEC
2344
if kind == 'symlink':
2345
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2346
executable = tt._new_executability.get(trans_id, executable)
2347
return kind, size, executable, link_or_sha1
2349
def iter_changes(self, from_tree, include_unchanged=False,
2350
specific_files=None, pb=None, extra_trees=None,
2351
require_versioned=True, want_unversioned=False):
2352
"""See InterTree.iter_changes.
2354
This has a fast path that is only used when the from_tree matches
2355
the transform tree, and no fancy options are supplied.
2357
if (from_tree is not self._transform._tree or include_unchanged or
2358
specific_files or want_unversioned):
2359
return tree.InterTree(from_tree, self).iter_changes(
2360
include_unchanged=include_unchanged,
2361
specific_files=specific_files,
2363
extra_trees=extra_trees,
2364
require_versioned=require_versioned,
2365
want_unversioned=want_unversioned)
2366
if want_unversioned:
2367
raise ValueError('want_unversioned is not supported')
2368
return self._transform.iter_changes()
2370
def get_file(self, file_id, path=None):
2371
"""See Tree.get_file"""
2372
if not self._content_change(file_id):
2373
return self._transform._tree.get_file(file_id, path)
2374
trans_id = self._transform.trans_id_file_id(file_id)
2375
name = self._transform._limbo_name(trans_id)
2376
return open(name, 'rb')
2378
def get_file_with_stat(self, file_id, path=None):
2379
return self.get_file(file_id, path), None
2381
def annotate_iter(self, file_id,
2382
default_revision=_mod_revision.CURRENT_REVISION):
2383
changes = self._iter_changes_cache.get(file_id)
2387
changed_content, versioned, kind = (changes[2], changes[3],
2391
get_old = (kind[0] == 'file' and versioned[0])
2393
old_annotation = self._transform._tree.annotate_iter(file_id,
2394
default_revision=default_revision)
2398
return old_annotation
2399
if not changed_content:
2400
return old_annotation
2401
# TODO: This is doing something similar to what WT.annotate_iter is
2402
# doing, however it fails slightly because it doesn't know what
2403
# the *other* revision_id is, so it doesn't know how to give the
2404
# other as the origin for some lines, they all get
2405
# 'default_revision'
2406
# It would be nice to be able to use the new Annotator based
2407
# approach, as well.
2408
return annotate.reannotate([old_annotation],
2409
self.get_file(file_id).readlines(),
2412
def get_symlink_target(self, file_id, path=None):
2413
"""See Tree.get_symlink_target"""
2414
if not self._content_change(file_id):
2415
return self._transform._tree.get_symlink_target(file_id)
2416
trans_id = self._transform.trans_id_file_id(file_id)
2417
name = self._transform._limbo_name(trans_id)
2418
return osutils.readlink(name)
2420
def walkdirs(self, prefix=''):
2421
pending = [self._transform.root]
2422
while len(pending) > 0:
2423
parent_id = pending.pop()
2426
prefix = prefix.rstrip('/')
2427
parent_path = self._final_paths.get_path(parent_id)
2428
parent_file_id = self._transform.final_file_id(parent_id)
2429
for child_id in self._all_children(parent_id):
2430
path_from_root = self._final_paths.get_path(child_id)
2431
basename = self._transform.final_name(child_id)
2432
file_id = self._transform.final_file_id(child_id)
2433
kind = self._transform.final_kind(child_id)
2434
if kind is not None:
2435
versioned_kind = kind
2438
versioned_kind = self._transform._tree.stored_kind(file_id)
2439
if versioned_kind == 'directory':
2440
subdirs.append(child_id)
2441
children.append((path_from_root, basename, kind, None,
2442
file_id, versioned_kind))
2444
if parent_path.startswith(prefix):
2445
yield (parent_path, parent_file_id), children
2446
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2449
def get_parent_ids(self):
2450
return self._parent_ids
2452
def set_parent_ids(self, parent_ids):
2453
self._parent_ids = parent_ids
2455
def get_revision_tree(self, revision_id):
2456
return self._transform._tree.get_revision_tree(revision_id)
2459
def joinpath(parent, child):
2460
"""Join tree-relative paths, handling the tree root specially"""
2461
if parent is None or parent == "":
2464
return pathjoin(parent, child)
2467
class FinalPaths(object):
2468
"""Make path calculation cheap by memoizing paths.
2470
The underlying tree must not be manipulated between calls, or else
2471
the results will likely be incorrect.
2473
def __init__(self, transform):
2474
object.__init__(self)
2475
self._known_paths = {}
2476
self.transform = transform
2478
def _determine_path(self, trans_id):
2479
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2481
name = self.transform.final_name(trans_id)
2482
parent_id = self.transform.final_parent(trans_id)
2483
if parent_id == self.transform.root:
2486
return pathjoin(self.get_path(parent_id), name)
2488
def get_path(self, trans_id):
2489
"""Find the final path associated with a trans_id"""
2490
if trans_id not in self._known_paths:
2491
self._known_paths[trans_id] = self._determine_path(trans_id)
2492
return self._known_paths[trans_id]
2494
def get_paths(self, trans_ids):
2495
return [(self.get_path(t), t) for t in trans_ids]
2499
def topology_sorted_ids(tree):
2500
"""Determine the topological order of the ids in a tree"""
2501
file_ids = list(tree)
2502
file_ids.sort(key=tree.id2path)
2506
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2507
delta_from_tree=False):
2508
"""Create working tree for a branch, using a TreeTransform.
2510
This function should be used on empty trees, having a tree root at most.
2511
(see merge and revert functionality for working with existing trees)
2513
Existing files are handled like so:
2515
- Existing bzrdirs take precedence over creating new items. They are
2516
created as '%s.diverted' % name.
2517
- Otherwise, if the content on disk matches the content we are building,
2518
it is silently replaced.
2519
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2521
:param tree: The tree to convert wt into a copy of
2522
:param wt: The working tree that files will be placed into
2523
:param accelerator_tree: A tree which can be used for retrieving file
2524
contents more quickly than tree itself, i.e. a workingtree. tree
2525
will be used for cases where accelerator_tree's content is different.
2526
:param hardlink: If true, hard-link files to accelerator_tree, where
2527
possible. accelerator_tree must implement abspath, i.e. be a
2529
:param delta_from_tree: If true, build_tree may use the input Tree to
2530
generate the inventory delta.
2532
wt.lock_tree_write()
2536
if accelerator_tree is not None:
2537
accelerator_tree.lock_read()
2539
return _build_tree(tree, wt, accelerator_tree, hardlink,
2542
if accelerator_tree is not None:
2543
accelerator_tree.unlock()
2550
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2551
"""See build_tree."""
2552
for num, _unused in enumerate(wt.all_file_ids()):
2553
if num > 0: # more than just a root
2554
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2556
top_pb = ui.ui_factory.nested_progress_bar()
2557
pp = ProgressPhase("Build phase", 2, top_pb)
2558
if tree.get_root_id() is not None:
2559
# This is kind of a hack: we should be altering the root
2560
# as part of the regular tree shape diff logic.
2561
# The conditional test here is to avoid doing an
2562
# expensive operation (flush) every time the root id
2563
# is set within the tree, nor setting the root and thus
2564
# marking the tree as dirty, because we use two different
2565
# idioms here: tree interfaces and inventory interfaces.
2566
if wt.get_root_id() != tree.get_root_id():
2567
wt.set_root_id(tree.get_root_id())
2569
tt = TreeTransform(wt)
2573
file_trans_id[wt.get_root_id()] = \
2574
tt.trans_id_tree_file_id(wt.get_root_id())
2575
pb = ui.ui_factory.nested_progress_bar()
2577
deferred_contents = []
2579
total = len(tree.all_file_ids())
2581
precomputed_delta = []
2583
precomputed_delta = None
2584
# Check if tree inventory has content. If so, we populate
2585
# existing_files with the directory content. If there are no
2586
# entries we skip populating existing_files as its not used.
2587
# This improves performance and unncessary work on large
2588
# directory trees. (#501307)
2590
existing_files = set()
2591
for dir, files in wt.walkdirs():
2592
existing_files.update(f[0] for f in files)
2593
for num, (tree_path, entry) in \
2594
enumerate(tree.iter_entries_by_dir()):
2595
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2596
if entry.parent_id is None:
2599
file_id = entry.file_id
2601
precomputed_delta.append((None, tree_path, file_id, entry))
2602
if tree_path in existing_files:
2603
target_path = wt.abspath(tree_path)
2604
kind = file_kind(target_path)
2605
if kind == "directory":
2607
controldir.ControlDir.open(target_path)
2608
except errors.NotBranchError:
2612
if (file_id not in divert and
2613
_content_match(tree, entry, file_id, kind,
2615
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2616
if kind == 'directory':
2618
parent_id = file_trans_id[entry.parent_id]
2619
if entry.kind == 'file':
2620
# We *almost* replicate new_by_entry, so that we can defer
2621
# getting the file text, and get them all at once.
2622
trans_id = tt.create_path(entry.name, parent_id)
2623
file_trans_id[file_id] = trans_id
2624
tt.version_file(file_id, trans_id)
2625
executable = tree.is_executable(file_id, tree_path)
2627
tt.set_executability(executable, trans_id)
2628
trans_data = (trans_id, tree_path, entry.text_sha1)
2629
deferred_contents.append((file_id, trans_data))
2631
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2634
new_trans_id = file_trans_id[file_id]
2635
old_parent = tt.trans_id_tree_path(tree_path)
2636
_reparent_children(tt, old_parent, new_trans_id)
2637
offset = num + 1 - len(deferred_contents)
2638
_create_files(tt, tree, deferred_contents, pb, offset,
2639
accelerator_tree, hardlink)
2643
divert_trans = set(file_trans_id[f] for f in divert)
2644
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2645
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2646
if len(raw_conflicts) > 0:
2647
precomputed_delta = None
2648
conflicts = cook_conflicts(raw_conflicts, tt)
2649
for conflict in conflicts:
2650
trace.warning(unicode(conflict))
2652
wt.add_conflicts(conflicts)
2653
except errors.UnsupportedOperation:
2655
result = tt.apply(no_conflicts=True,
2656
precomputed_delta=precomputed_delta)
2663
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2665
total = len(desired_files) + offset
2667
if accelerator_tree is None:
2668
new_desired_files = desired_files
2670
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2671
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2672
in iter if not (c or e[0] != e[1])]
2673
if accelerator_tree.supports_content_filtering():
2674
unchanged = [(f, p) for (f, p) in unchanged
2675
if not accelerator_tree.iter_search_rules([p]).next()]
2676
unchanged = dict(unchanged)
2677
new_desired_files = []
2679
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2680
accelerator_path = unchanged.get(file_id)
2681
if accelerator_path is None:
2682
new_desired_files.append((file_id,
2683
(trans_id, tree_path, text_sha1)))
2685
pb.update(gettext('Adding file contents'), count + offset, total)
2687
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2690
contents = accelerator_tree.get_file(file_id, accelerator_path)
2691
if wt.supports_content_filtering():
2692
filters = wt._content_filter_stack(tree_path)
2693
contents = filtered_output_bytes(contents, filters,
2694
ContentFilterContext(tree_path, tree))
2696
tt.create_file(contents, trans_id, sha1=text_sha1)
2700
except AttributeError:
2701
# after filtering, contents may no longer be file-like
2705
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2706
tree.iter_files_bytes(new_desired_files)):
2707
if wt.supports_content_filtering():
2708
filters = wt._content_filter_stack(tree_path)
2709
contents = filtered_output_bytes(contents, filters,
2710
ContentFilterContext(tree_path, tree))
2711
tt.create_file(contents, trans_id, sha1=text_sha1)
2712
pb.update(gettext('Adding file contents'), count + offset, total)
2715
def _reparent_children(tt, old_parent, new_parent):
2716
for child in tt.iter_tree_children(old_parent):
2717
tt.adjust_path(tt.final_name(child), new_parent, child)
2720
def _reparent_transform_children(tt, old_parent, new_parent):
2721
by_parent = tt.by_parent()
2722
for child in by_parent[old_parent]:
2723
tt.adjust_path(tt.final_name(child), new_parent, child)
2724
return by_parent[old_parent]
2727
def _content_match(tree, entry, file_id, kind, target_path):
2728
if entry.kind != kind:
2730
if entry.kind == "directory":
2732
if entry.kind == "file":
2733
f = file(target_path, 'rb')
2735
if tree.get_file_text(file_id) == f.read():
2739
elif entry.kind == "symlink":
2740
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2745
def resolve_checkout(tt, conflicts, divert):
2746
new_conflicts = set()
2747
for c_type, conflict in ((c[0], c) for c in conflicts):
2748
# Anything but a 'duplicate' would indicate programmer error
2749
if c_type != 'duplicate':
2750
raise AssertionError(c_type)
2751
# Now figure out which is new and which is old
2752
if tt.new_contents(conflict[1]):
2753
new_file = conflict[1]
2754
old_file = conflict[2]
2756
new_file = conflict[2]
2757
old_file = conflict[1]
2759
# We should only get here if the conflict wasn't completely
2761
final_parent = tt.final_parent(old_file)
2762
if new_file in divert:
2763
new_name = tt.final_name(old_file)+'.diverted'
2764
tt.adjust_path(new_name, final_parent, new_file)
2765
new_conflicts.add((c_type, 'Diverted to',
2766
new_file, old_file))
2768
new_name = tt.final_name(old_file)+'.moved'
2769
tt.adjust_path(new_name, final_parent, old_file)
2770
new_conflicts.add((c_type, 'Moved existing file to',
2771
old_file, new_file))
2772
return new_conflicts
2775
def new_by_entry(tt, entry, parent_id, tree):
2776
"""Create a new file according to its inventory entry"""
2780
contents = tree.get_file(entry.file_id).readlines()
2781
executable = tree.is_executable(entry.file_id)
2782
return tt.new_file(name, parent_id, contents, entry.file_id,
2784
elif kind in ('directory', 'tree-reference'):
2785
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2786
if kind == 'tree-reference':
2787
tt.set_tree_reference(entry.reference_revision, trans_id)
2789
elif kind == 'symlink':
2790
target = tree.get_symlink_target(entry.file_id)
2791
return tt.new_symlink(name, parent_id, target, entry.file_id)
2793
raise errors.BadFileKindError(name, kind)
2796
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2797
filter_tree_path=None):
2798
"""Create new file contents according to tree contents.
2800
:param filter_tree_path: the tree path to use to lookup
2801
content filters to apply to the bytes output in the working tree.
2802
This only applies if the working tree supports content filtering.
2804
kind = tree.kind(file_id)
2805
if kind == 'directory':
2806
tt.create_directory(trans_id)
2807
elif kind == "file":
2809
tree_file = tree.get_file(file_id)
2811
bytes = tree_file.readlines()
2815
if wt.supports_content_filtering() and filter_tree_path is not None:
2816
filters = wt._content_filter_stack(filter_tree_path)
2817
bytes = filtered_output_bytes(bytes, filters,
2818
ContentFilterContext(filter_tree_path, tree))
2819
tt.create_file(bytes, trans_id)
2820
elif kind == "symlink":
2821
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2823
raise AssertionError('Unknown kind %r' % kind)
2826
def create_entry_executability(tt, entry, trans_id):
2827
"""Set the executability of a trans_id according to an inventory entry"""
2828
if entry.kind == "file":
2829
tt.set_executability(entry.executable, trans_id)
2832
@deprecated_function(deprecated_in((2, 3, 0)))
2833
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2834
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2837
@deprecated_function(deprecated_in((2, 3, 0)))
2838
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2839
"""Produce a backup-style name that appears to be available"""
2843
yield "%s.~%d~" % (name, counter)
2845
for new_name in name_gen():
2846
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2850
def revert(working_tree, target_tree, filenames, backups=False,
2851
pb=None, change_reporter=None):
2852
"""Revert a working tree's contents to those of a target tree."""
2853
target_tree.lock_read()
2854
pb = ui.ui_factory.nested_progress_bar()
2855
tt = TreeTransform(working_tree, pb)
2857
pp = ProgressPhase("Revert phase", 3, pb)
2858
conflicts, merge_modified = _prepare_revert_transform(
2859
working_tree, target_tree, tt, filenames, backups, pp)
2861
change_reporter = delta._ChangeReporter(
2862
unversioned_filter=working_tree.is_ignored)
2863
delta.report_changes(tt.iter_changes(), change_reporter)
2864
for conflict in conflicts:
2865
trace.warning(unicode(conflict))
2868
working_tree.set_merge_modified(merge_modified)
2870
target_tree.unlock()
2876
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2877
backups, pp, basis_tree=None,
2878
merge_modified=None):
2879
child_pb = ui.ui_factory.nested_progress_bar()
2881
if merge_modified is None:
2882
merge_modified = working_tree.merge_modified()
2883
merge_modified = _alter_files(working_tree, target_tree, tt,
2884
child_pb, filenames, backups,
2885
merge_modified, basis_tree)
2888
child_pb = ui.ui_factory.nested_progress_bar()
2890
raw_conflicts = resolve_conflicts(tt, child_pb,
2891
lambda t, c: conflict_pass(t, c, target_tree))
2894
conflicts = cook_conflicts(raw_conflicts, tt)
2895
return conflicts, merge_modified
2898
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2899
backups, merge_modified, basis_tree=None):
2900
if basis_tree is not None:
2901
basis_tree.lock_read()
2902
# We ask the working_tree for its changes relative to the target, rather
2903
# than the target changes relative to the working tree. Because WT4 has an
2904
# optimizer to compare itself to a target, but no optimizer for the
2906
change_list = working_tree.iter_changes(target_tree,
2907
specific_files=specific_files, pb=pb)
2908
if target_tree.get_root_id() is None:
2914
for id_num, (file_id, path, changed_content, versioned, parent, name,
2915
kind, executable) in enumerate(change_list):
2916
target_path, wt_path = path
2917
target_versioned, wt_versioned = versioned
2918
target_parent, wt_parent = parent
2919
target_name, wt_name = name
2920
target_kind, wt_kind = kind
2921
target_executable, wt_executable = executable
2922
if skip_root and wt_parent is None:
2924
trans_id = tt.trans_id_file_id(file_id)
2927
keep_content = False
2928
if wt_kind == 'file' and (backups or target_kind is None):
2929
wt_sha1 = working_tree.get_file_sha1(file_id)
2930
if merge_modified.get(file_id) != wt_sha1:
2931
# acquire the basis tree lazily to prevent the
2932
# expense of accessing it when it's not needed ?
2933
# (Guessing, RBC, 200702)
2934
if basis_tree is None:
2935
basis_tree = working_tree.basis_tree()
2936
basis_tree.lock_read()
2937
if basis_tree.has_id(file_id):
2938
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2940
elif target_kind is None and not target_versioned:
2942
if wt_kind is not None:
2943
if not keep_content:
2944
tt.delete_contents(trans_id)
2945
elif target_kind is not None:
2946
parent_trans_id = tt.trans_id_file_id(wt_parent)
2947
backup_name = tt._available_backup_name(
2948
wt_name, parent_trans_id)
2949
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2950
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2951
if wt_versioned and target_versioned:
2952
tt.unversion_file(trans_id)
2953
tt.version_file(file_id, new_trans_id)
2954
# New contents should have the same unix perms as old
2957
trans_id = new_trans_id
2958
if target_kind in ('directory', 'tree-reference'):
2959
tt.create_directory(trans_id)
2960
if target_kind == 'tree-reference':
2961
revision = target_tree.get_reference_revision(file_id,
2963
tt.set_tree_reference(revision, trans_id)
2964
elif target_kind == 'symlink':
2965
tt.create_symlink(target_tree.get_symlink_target(file_id),
2967
elif target_kind == 'file':
2968
deferred_files.append((file_id, (trans_id, mode_id)))
2969
if basis_tree is None:
2970
basis_tree = working_tree.basis_tree()
2971
basis_tree.lock_read()
2972
new_sha1 = target_tree.get_file_sha1(file_id)
2973
if (basis_tree.has_id(file_id) and
2974
new_sha1 == basis_tree.get_file_sha1(file_id)):
2975
if file_id in merge_modified:
2976
del merge_modified[file_id]
2978
merge_modified[file_id] = new_sha1
2980
# preserve the execute bit when backing up
2981
if keep_content and wt_executable == target_executable:
2982
tt.set_executability(target_executable, trans_id)
2983
elif target_kind is not None:
2984
raise AssertionError(target_kind)
2985
if not wt_versioned and target_versioned:
2986
tt.version_file(file_id, trans_id)
2987
if wt_versioned and not target_versioned:
2988
tt.unversion_file(trans_id)
2989
if (target_name is not None and
2990
(wt_name != target_name or wt_parent != target_parent)):
2991
if target_name == '' and target_parent is None:
2992
parent_trans = ROOT_PARENT
2994
parent_trans = tt.trans_id_file_id(target_parent)
2995
if wt_parent is None and wt_versioned:
2996
tt.adjust_root_path(target_name, parent_trans)
2998
tt.adjust_path(target_name, parent_trans, trans_id)
2999
if wt_executable != target_executable and target_kind == "file":
3000
tt.set_executability(target_executable, trans_id)
3001
if working_tree.supports_content_filtering():
3002
for index, ((trans_id, mode_id), bytes) in enumerate(
3003
target_tree.iter_files_bytes(deferred_files)):
3004
file_id = deferred_files[index][0]
3005
# We're reverting a tree to the target tree so using the
3006
# target tree to find the file path seems the best choice
3007
# here IMO - Ian C 27/Oct/2009
3008
filter_tree_path = target_tree.id2path(file_id)
3009
filters = working_tree._content_filter_stack(filter_tree_path)
3010
bytes = filtered_output_bytes(bytes, filters,
3011
ContentFilterContext(filter_tree_path, working_tree))
3012
tt.create_file(bytes, trans_id, mode_id)
3014
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3016
tt.create_file(bytes, trans_id, mode_id)
3017
tt.fixup_new_roots()
3019
if basis_tree is not None:
3021
return merge_modified
3024
def resolve_conflicts(tt, pb=None, pass_func=None):
3025
"""Make many conflict-resolution attempts, but die if they fail"""
3026
if pass_func is None:
3027
pass_func = conflict_pass
3028
new_conflicts = set()
3029
pb = ui.ui_factory.nested_progress_bar()
3032
pb.update(gettext('Resolution pass'), n+1, 10)
3033
conflicts = tt.find_conflicts()
3034
if len(conflicts) == 0:
3035
return new_conflicts
3036
new_conflicts.update(pass_func(tt, conflicts))
3037
raise MalformedTransform(conflicts=conflicts)
3042
def conflict_pass(tt, conflicts, path_tree=None):
3043
"""Resolve some classes of conflicts.
3045
:param tt: The transform to resolve conflicts in
3046
:param conflicts: The conflicts to resolve
3047
:param path_tree: A Tree to get supplemental paths from
3049
new_conflicts = set()
3050
for c_type, conflict in ((c[0], c) for c in conflicts):
3051
if c_type == 'duplicate id':
3052
tt.unversion_file(conflict[1])
3053
new_conflicts.add((c_type, 'Unversioned existing file',
3054
conflict[1], conflict[2], ))
3055
elif c_type == 'duplicate':
3056
# files that were renamed take precedence
3057
final_parent = tt.final_parent(conflict[1])
3058
if tt.path_changed(conflict[1]):
3059
existing_file, new_file = conflict[2], conflict[1]
3061
existing_file, new_file = conflict[1], conflict[2]
3062
new_name = tt.final_name(existing_file) + '.moved'
3063
tt.adjust_path(new_name, final_parent, existing_file)
3064
new_conflicts.add((c_type, 'Moved existing file to',
3065
existing_file, new_file))
3066
elif c_type == 'parent loop':
3067
# break the loop by undoing one of the ops that caused the loop
3069
while not tt.path_changed(cur):
3070
cur = tt.final_parent(cur)
3071
new_conflicts.add((c_type, 'Cancelled move', cur,
3072
tt.final_parent(cur),))
3073
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3075
elif c_type == 'missing parent':
3076
trans_id = conflict[1]
3077
if trans_id in tt._removed_contents:
3078
cancel_deletion = True
3079
orphans = tt._get_potential_orphans(trans_id)
3081
cancel_deletion = False
3082
# All children are orphans
3085
tt.new_orphan(o, trans_id)
3086
except OrphaningError:
3087
# Something bad happened so we cancel the directory
3088
# deletion which will leave it in place with a
3089
# conflict. The user can deal with it from there.
3090
# Note that this also catch the case where we don't
3091
# want to create orphans and leave the directory in
3093
cancel_deletion = True
3096
# Cancel the directory deletion
3097
tt.cancel_deletion(trans_id)
3098
new_conflicts.add(('deleting parent', 'Not deleting',
3103
tt.final_name(trans_id)
3105
if path_tree is not None:
3106
file_id = tt.final_file_id(trans_id)
3108
file_id = tt.inactive_file_id(trans_id)
3109
_, entry = path_tree.iter_entries_by_dir(
3111
# special-case the other tree root (move its
3112
# children to current root)
3113
if entry.parent_id is None:
3115
moved = _reparent_transform_children(
3116
tt, trans_id, tt.root)
3118
new_conflicts.add((c_type, 'Moved to root',
3121
parent_trans_id = tt.trans_id_file_id(
3123
tt.adjust_path(entry.name, parent_trans_id,
3126
tt.create_directory(trans_id)
3127
new_conflicts.add((c_type, 'Created directory', trans_id))
3128
elif c_type == 'unversioned parent':
3129
file_id = tt.inactive_file_id(conflict[1])
3130
# special-case the other tree root (move its children instead)
3131
if path_tree and path_tree.has_id(file_id):
3132
if path_tree.path2id('') == file_id:
3133
# This is the root entry, skip it
3135
tt.version_file(file_id, conflict[1])
3136
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3137
elif c_type == 'non-directory parent':
3138
parent_id = conflict[1]
3139
parent_parent = tt.final_parent(parent_id)
3140
parent_name = tt.final_name(parent_id)
3141
parent_file_id = tt.final_file_id(parent_id)
3142
new_parent_id = tt.new_directory(parent_name + '.new',
3143
parent_parent, parent_file_id)
3144
_reparent_transform_children(tt, parent_id, new_parent_id)
3145
if parent_file_id is not None:
3146
tt.unversion_file(parent_id)
3147
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3148
elif c_type == 'versioning no contents':
3149
tt.cancel_versioning(conflict[1])
3150
return new_conflicts
3153
def cook_conflicts(raw_conflicts, tt):
3154
"""Generate a list of cooked conflicts, sorted by file path"""
3155
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3156
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3159
def iter_cook_conflicts(raw_conflicts, tt):
3161
for conflict in raw_conflicts:
3162
c_type = conflict[0]
3163
action = conflict[1]
3164
modified_path = fp.get_path(conflict[2])
3165
modified_id = tt.final_file_id(conflict[2])
3166
if len(conflict) == 3:
3167
yield conflicts.Conflict.factory(
3168
c_type, action=action, path=modified_path, file_id=modified_id)
3171
conflicting_path = fp.get_path(conflict[3])
3172
conflicting_id = tt.final_file_id(conflict[3])
3173
yield conflicts.Conflict.factory(
3174
c_type, action=action, path=modified_path,
3175
file_id=modified_id,
3176
conflict_path=conflicting_path,
3177
conflict_file_id=conflicting_id)
3180
class _FileMover(object):
3181
"""Moves and deletes files for TreeTransform, tracking operations"""
3184
self.past_renames = []
3185
self.pending_deletions = []
3187
def rename(self, from_, to):
3188
"""Rename a file from one path to another."""
3190
os.rename(from_, to)
3192
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3193
raise errors.FileExists(to, str(e))
3194
# normal OSError doesn't include filenames so it's hard to see where
3195
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3196
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3197
self.past_renames.append((from_, to))
3199
def pre_delete(self, from_, to):
3200
"""Rename a file out of the way and mark it for deletion.
3202
Unlike os.unlink, this works equally well for files and directories.
3203
:param from_: The current file path
3204
:param to: A temporary path for the file
3206
self.rename(from_, to)
3207
self.pending_deletions.append(to)
3210
"""Reverse all renames that have been performed"""
3211
for from_, to in reversed(self.past_renames):
3213
os.rename(to, from_)
3215
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3216
# after rollback, don't reuse _FileMover
3218
pending_deletions = None
3220
def apply_deletions(self):
3221
"""Apply all marked deletions"""
3222
for path in self.pending_deletions:
3224
# after apply_deletions, don't reuse _FileMover
3226
pending_deletions = None
added
removed
bzrlib/transform.py
