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
19
from stat import S_ISREG, S_IEXEC
29
lazy_import.lazy_import(globals(), """
41
revision as _mod_revision,
45
from bzrlib.i18n import gettext
47
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
48
ReusingTransform, CantMoveRoot,
49
ExistingLimbo, ImmortalLimbo, NoFinalPath,
51
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
52
from bzrlib.osutils import (
61
from bzrlib.progress import ProgressPhase
62
from bzrlib.symbol_versioning import (
69
ROOT_PARENT = "root-parent"
71
def unique_add(map, key, value):
73
raise DuplicateKey(key=key)
78
class _TransformResults(object):
79
def __init__(self, modified_paths, rename_count):
81
self.modified_paths = modified_paths
82
self.rename_count = rename_count
85
class TreeTransformBase(object):
86
"""The base class for TreeTransform and its kin."""
88
def __init__(self, tree, pb=None,
92
:param tree: The tree that will be transformed, but not necessarily
95
:param case_sensitive: If True, the target of the transform is
96
case sensitive, not just case preserving.
101
# mapping of trans_id -> new basename
103
# mapping of trans_id -> new parent trans_id
104
self._new_parent = {}
105
# mapping of trans_id with new contents -> new file_kind
106
self._new_contents = {}
107
# mapping of trans_id => (sha1 of content, stat_value)
108
self._observed_sha1s = {}
109
# Set of trans_ids whose contents will be removed
110
self._removed_contents = set()
111
# Mapping of trans_id -> new execute-bit value
112
self._new_executability = {}
113
# Mapping of trans_id -> new tree-reference value
114
self._new_reference_revision = {}
115
# Mapping of trans_id -> new file_id
117
# Mapping of old file-id -> trans_id
118
self._non_present_ids = {}
119
# Mapping of new file_id -> trans_id
121
# Set of trans_ids that will be removed
122
self._removed_id = set()
123
# Mapping of path in old tree -> trans_id
124
self._tree_path_ids = {}
125
# Mapping trans_id -> path in old tree
126
self._tree_id_paths = {}
127
# The trans_id that will be used as the tree root
128
root_id = tree.get_root_id()
129
if root_id is not None:
130
self._new_root = self.trans_id_tree_file_id(root_id)
132
self._new_root = None
133
# Indicator of whether the transform has been applied
137
# Whether the target is case sensitive
138
self._case_sensitive_target = case_sensitive
139
# A counter of how many files have been renamed
140
self.rename_count = 0
143
"""Support Context Manager API."""
146
def __exit__(self, exc_type, exc_val, exc_tb):
147
"""Support Context Manager API."""
151
"""Release the working tree lock, if held.
153
This is required if apply has not been invoked, but can be invoked
156
if self._tree is None:
161
def __get_root(self):
162
return self._new_root
164
root = property(__get_root)
166
def _assign_id(self):
167
"""Produce a new tranform id"""
168
new_id = "new-%s" % self._id_number
172
def create_path(self, name, parent):
173
"""Assign a transaction id to a new path"""
174
trans_id = self._assign_id()
175
unique_add(self._new_name, trans_id, name)
176
unique_add(self._new_parent, trans_id, parent)
179
def adjust_path(self, name, parent, trans_id):
180
"""Change the path that is assigned to a transaction id."""
182
raise ValueError("Parent trans-id may not be None")
183
if trans_id == self._new_root:
185
self._new_name[trans_id] = name
186
self._new_parent[trans_id] = parent
188
def adjust_root_path(self, name, parent):
189
"""Emulate moving the root by moving all children, instead.
191
We do this by undoing the association of root's transaction id with the
192
current tree. This allows us to create a new directory with that
193
transaction id. We unversion the root directory and version the
194
physically new directory, and hope someone versions the tree root
197
old_root = self._new_root
198
old_root_file_id = self.final_file_id(old_root)
199
# force moving all children of root
200
for child_id in self.iter_tree_children(old_root):
201
if child_id != parent:
202
self.adjust_path(self.final_name(child_id),
203
self.final_parent(child_id), child_id)
204
file_id = self.final_file_id(child_id)
205
if file_id is not None:
206
self.unversion_file(child_id)
207
self.version_file(file_id, child_id)
209
# the physical root needs a new transaction id
210
self._tree_path_ids.pop("")
211
self._tree_id_paths.pop(old_root)
212
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
213
if parent == old_root:
214
parent = self._new_root
215
self.adjust_path(name, parent, old_root)
216
self.create_directory(old_root)
217
self.version_file(old_root_file_id, old_root)
218
self.unversion_file(self._new_root)
220
def fixup_new_roots(self):
221
"""Reinterpret requests to change the root directory
223
Instead of creating a root directory, or moving an existing directory,
224
all the attributes and children of the new root are applied to the
225
existing root directory.
227
This means that the old root trans-id becomes obsolete, so it is
228
recommended only to invoke this after the root trans-id has become
232
new_roots = [k for k, v in self._new_parent.iteritems() if v is
234
if len(new_roots) < 1:
236
if len(new_roots) != 1:
237
raise ValueError('A tree cannot have two roots!')
238
if self._new_root is None:
239
self._new_root = new_roots[0]
241
old_new_root = new_roots[0]
242
# unversion the new root's directory.
243
if self.final_kind(self._new_root) is None:
244
file_id = self.final_file_id(old_new_root)
246
file_id = self.final_file_id(self._new_root)
247
if old_new_root in self._new_id:
248
self.cancel_versioning(old_new_root)
250
self.unversion_file(old_new_root)
251
# if, at this stage, root still has an old file_id, zap it so we can
252
# stick a new one in.
253
if (self.tree_file_id(self._new_root) is not None and
254
self._new_root not in self._removed_id):
255
self.unversion_file(self._new_root)
256
if file_id is not None:
257
self.version_file(file_id, self._new_root)
259
# Now move children of new root into old root directory.
260
# Ensure all children are registered with the transaction, but don't
261
# use directly-- some tree children have new parents
262
list(self.iter_tree_children(old_new_root))
263
# Move all children of new root into old root directory.
264
for child in self.by_parent().get(old_new_root, []):
265
self.adjust_path(self.final_name(child), self._new_root, child)
267
# Ensure old_new_root has no directory.
268
if old_new_root in self._new_contents:
269
self.cancel_creation(old_new_root)
271
self.delete_contents(old_new_root)
273
# prevent deletion of root directory.
274
if self._new_root in self._removed_contents:
275
self.cancel_deletion(self._new_root)
277
# destroy path info for old_new_root.
278
del self._new_parent[old_new_root]
279
del self._new_name[old_new_root]
281
def trans_id_tree_file_id(self, inventory_id):
282
"""Determine the transaction id of a working tree file.
284
This reflects only files that already exist, not ones that will be
285
added by transactions.
287
if inventory_id is None:
288
raise ValueError('None is not a valid file id')
289
path = self._tree.id2path(inventory_id)
290
return self.trans_id_tree_path(path)
292
def trans_id_file_id(self, file_id):
293
"""Determine or set the transaction id associated with a file ID.
294
A new id is only created for file_ids that were never present. If
295
a transaction has been unversioned, it is deliberately still returned.
296
(this will likely lead to an unversioned parent conflict.)
299
raise ValueError('None is not a valid file id')
300
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
301
return self._r_new_id[file_id]
304
self._tree.iter_entries_by_dir([file_id]).next()
305
except StopIteration:
306
if file_id in self._non_present_ids:
307
return self._non_present_ids[file_id]
309
trans_id = self._assign_id()
310
self._non_present_ids[file_id] = trans_id
313
return self.trans_id_tree_file_id(file_id)
315
def trans_id_tree_path(self, path):
316
"""Determine (and maybe set) the transaction ID for a tree path."""
317
path = self.canonical_path(path)
318
if path not in self._tree_path_ids:
319
self._tree_path_ids[path] = self._assign_id()
320
self._tree_id_paths[self._tree_path_ids[path]] = path
321
return self._tree_path_ids[path]
323
def get_tree_parent(self, trans_id):
324
"""Determine id of the parent in the tree."""
325
path = self._tree_id_paths[trans_id]
328
return self.trans_id_tree_path(os.path.dirname(path))
330
def delete_contents(self, trans_id):
331
"""Schedule the contents of a path entry for deletion"""
332
kind = self.tree_kind(trans_id)
334
self._removed_contents.add(trans_id)
336
def cancel_deletion(self, trans_id):
337
"""Cancel a scheduled deletion"""
338
self._removed_contents.remove(trans_id)
340
def unversion_file(self, trans_id):
341
"""Schedule a path entry to become unversioned"""
342
self._removed_id.add(trans_id)
344
def delete_versioned(self, trans_id):
345
"""Delete and unversion a versioned file"""
346
self.delete_contents(trans_id)
347
self.unversion_file(trans_id)
349
def set_executability(self, executability, trans_id):
350
"""Schedule setting of the 'execute' bit
351
To unschedule, set to None
353
if executability is None:
354
del self._new_executability[trans_id]
356
unique_add(self._new_executability, trans_id, executability)
358
def set_tree_reference(self, revision_id, trans_id):
359
"""Set the reference associated with a directory"""
360
unique_add(self._new_reference_revision, trans_id, revision_id)
362
def version_file(self, file_id, trans_id):
363
"""Schedule a file to become versioned."""
366
unique_add(self._new_id, trans_id, file_id)
367
unique_add(self._r_new_id, file_id, trans_id)
369
def cancel_versioning(self, trans_id):
370
"""Undo a previous versioning of a file"""
371
file_id = self._new_id[trans_id]
372
del self._new_id[trans_id]
373
del self._r_new_id[file_id]
375
def new_paths(self, filesystem_only=False):
376
"""Determine the paths of all new and changed files.
378
:param filesystem_only: if True, only calculate values for files
379
that require renames or execute bit changes.
383
stale_ids = self._needs_rename.difference(self._new_name)
384
stale_ids.difference_update(self._new_parent)
385
stale_ids.difference_update(self._new_contents)
386
stale_ids.difference_update(self._new_id)
387
needs_rename = self._needs_rename.difference(stale_ids)
388
id_sets = (needs_rename, self._new_executability)
390
id_sets = (self._new_name, self._new_parent, self._new_contents,
391
self._new_id, self._new_executability)
392
for id_set in id_sets:
393
new_ids.update(id_set)
394
return sorted(FinalPaths(self).get_paths(new_ids))
396
def _inventory_altered(self):
397
"""Determine which trans_ids need new Inventory entries.
399
An new entry is needed when anything that would be reflected by an
400
inventory entry changes, including file name, file_id, parent file_id,
401
file kind, and the execute bit.
403
Some care is taken to return entries with real changes, not cases
404
where the value is deleted and then restored to its original value,
405
but some actually unchanged values may be returned.
407
:returns: A list of (path, trans_id) for all items requiring an
408
inventory change. Ordered by path.
411
# Find entries whose file_ids are new (or changed).
412
new_file_id = set(t for t in self._new_id
413
if self._new_id[t] != self.tree_file_id(t))
414
for id_set in [self._new_name, self._new_parent, new_file_id,
415
self._new_executability]:
416
changed_ids.update(id_set)
417
# removing implies a kind change
418
changed_kind = set(self._removed_contents)
420
changed_kind.intersection_update(self._new_contents)
421
# Ignore entries that are already known to have changed.
422
changed_kind.difference_update(changed_ids)
423
# to keep only the truly changed ones
424
changed_kind = (t for t in changed_kind
425
if self.tree_kind(t) != self.final_kind(t))
426
# all kind changes will alter the inventory
427
changed_ids.update(changed_kind)
428
# To find entries with changed parent_ids, find parents which existed,
429
# but changed file_id.
430
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
431
# Now add all their children to the set.
432
for parent_trans_id in new_file_id:
433
changed_ids.update(self.iter_tree_children(parent_trans_id))
434
return sorted(FinalPaths(self).get_paths(changed_ids))
436
def final_kind(self, trans_id):
437
"""Determine the final file kind, after any changes applied.
439
:return: None if the file does not exist/has no contents. (It is
440
conceivable that a path would be created without the corresponding
441
contents insertion command)
443
if trans_id in self._new_contents:
444
return self._new_contents[trans_id]
445
elif trans_id in self._removed_contents:
448
return self.tree_kind(trans_id)
450
def tree_file_id(self, trans_id):
451
"""Determine the file id associated with the trans_id in the tree"""
453
path = self._tree_id_paths[trans_id]
455
# the file is a new, unversioned file, or invalid trans_id
457
# the file is old; the old id is still valid
458
if self._new_root == trans_id:
459
return self._tree.get_root_id()
460
return self._tree.path2id(path)
462
def final_file_id(self, trans_id):
463
"""Determine the file id after any changes are applied, or None.
465
None indicates that the file will not be versioned after changes are
469
return self._new_id[trans_id]
471
if trans_id in self._removed_id:
473
return self.tree_file_id(trans_id)
475
def inactive_file_id(self, trans_id):
476
"""Return the inactive file_id associated with a transaction id.
477
That is, the one in the tree or in non_present_ids.
478
The file_id may actually be active, too.
480
file_id = self.tree_file_id(trans_id)
481
if file_id is not None:
483
for key, value in self._non_present_ids.iteritems():
484
if value == trans_id:
487
def final_parent(self, trans_id):
488
"""Determine the parent file_id, after any changes are applied.
490
ROOT_PARENT is returned for the tree root.
493
return self._new_parent[trans_id]
495
return self.get_tree_parent(trans_id)
497
def final_name(self, trans_id):
498
"""Determine the final filename, after all changes are applied."""
500
return self._new_name[trans_id]
503
return os.path.basename(self._tree_id_paths[trans_id])
505
raise NoFinalPath(trans_id, self)
508
"""Return a map of parent: children for known parents.
510
Only new paths and parents of tree files with assigned ids are used.
513
items = list(self._new_parent.iteritems())
514
items.extend((t, self.final_parent(t)) for t in
515
self._tree_id_paths.keys())
516
for trans_id, parent_id in items:
517
if parent_id not in by_parent:
518
by_parent[parent_id] = set()
519
by_parent[parent_id].add(trans_id)
522
def path_changed(self, trans_id):
523
"""Return True if a trans_id's path has changed."""
524
return (trans_id in self._new_name) or (trans_id in self._new_parent)
526
def new_contents(self, trans_id):
527
return (trans_id in self._new_contents)
529
def find_conflicts(self):
530
"""Find any violations of inventory or filesystem invariants"""
531
if self._done is True:
532
raise ReusingTransform()
534
# ensure all children of all existent parents are known
535
# all children of non-existent parents are known, by definition.
536
self._add_tree_children()
537
by_parent = self.by_parent()
538
conflicts.extend(self._unversioned_parents(by_parent))
539
conflicts.extend(self._parent_loops())
540
conflicts.extend(self._duplicate_entries(by_parent))
541
conflicts.extend(self._duplicate_ids())
542
conflicts.extend(self._parent_type_conflicts(by_parent))
543
conflicts.extend(self._improper_versioning())
544
conflicts.extend(self._executability_conflicts())
545
conflicts.extend(self._overwrite_conflicts())
548
def _check_malformed(self):
549
conflicts = self.find_conflicts()
550
if len(conflicts) != 0:
551
raise MalformedTransform(conflicts=conflicts)
553
def _add_tree_children(self):
554
"""Add all the children of all active parents to the known paths.
556
Active parents are those which gain children, and those which are
557
removed. This is a necessary first step in detecting conflicts.
559
parents = self.by_parent().keys()
560
parents.extend([t for t in self._removed_contents if
561
self.tree_kind(t) == 'directory'])
562
for trans_id in self._removed_id:
563
file_id = self.tree_file_id(trans_id)
564
if file_id is not None:
565
# XXX: This seems like something that should go via a different
567
if self._tree.inventory[file_id].kind == 'directory':
568
parents.append(trans_id)
569
elif self.tree_kind(trans_id) == 'directory':
570
parents.append(trans_id)
572
for parent_id in parents:
573
# ensure that all children are registered with the transaction
574
list(self.iter_tree_children(parent_id))
576
@deprecated_method(deprecated_in((2, 3, 0)))
577
def has_named_child(self, by_parent, parent_id, name):
578
return self._has_named_child(
579
name, parent_id, known_children=by_parent.get(parent_id, []))
581
def _has_named_child(self, name, parent_id, known_children):
582
"""Does a parent already have a name child.
584
:param name: The searched for name.
586
:param parent_id: The parent for which the check is made.
588
:param known_children: The already known children. This should have
589
been recently obtained from `self.by_parent.get(parent_id)`
590
(or will be if None is passed).
592
if known_children is None:
593
known_children = self.by_parent().get(parent_id, [])
594
for child in known_children:
595
if self.final_name(child) == name:
597
parent_path = self._tree_id_paths.get(parent_id, None)
598
if parent_path is None:
599
# No parent... no children
601
child_path = joinpath(parent_path, name)
602
child_id = self._tree_path_ids.get(child_path, None)
604
# Not known by the tree transform yet, check the filesystem
605
return osutils.lexists(self._tree.abspath(child_path))
607
raise AssertionError('child_id is missing: %s, %s, %s'
608
% (name, parent_id, child_id))
610
def _available_backup_name(self, name, target_id):
611
"""Find an available backup name.
613
:param name: The basename of the file.
615
:param target_id: The directory trans_id where the backup should
618
known_children = self.by_parent().get(target_id, [])
619
return osutils.available_backup_name(
621
lambda base: self._has_named_child(
622
base, target_id, known_children))
624
def _parent_loops(self):
625
"""No entry should be its own ancestor"""
627
for trans_id in self._new_parent:
630
while parent_id is not ROOT_PARENT:
633
parent_id = self.final_parent(parent_id)
636
if parent_id == trans_id:
637
conflicts.append(('parent loop', trans_id))
638
if parent_id in seen:
642
def _unversioned_parents(self, by_parent):
643
"""If parent directories are versioned, children must be versioned."""
645
for parent_id, children in by_parent.iteritems():
646
if parent_id is ROOT_PARENT:
648
if self.final_file_id(parent_id) is not None:
650
for child_id in children:
651
if self.final_file_id(child_id) is not None:
652
conflicts.append(('unversioned parent', parent_id))
656
def _improper_versioning(self):
657
"""Cannot version a file with no contents, or a bad type.
659
However, existing entries with no contents are okay.
662
for trans_id in self._new_id.iterkeys():
663
kind = self.final_kind(trans_id)
665
conflicts.append(('versioning no contents', trans_id))
667
if not inventory.InventoryEntry.versionable_kind(kind):
668
conflicts.append(('versioning bad kind', trans_id, kind))
671
def _executability_conflicts(self):
672
"""Check for bad executability changes.
674
Only versioned files may have their executability set, because
675
1. only versioned entries can have executability under windows
676
2. only files can be executable. (The execute bit on a directory
677
does not indicate searchability)
680
for trans_id in self._new_executability:
681
if self.final_file_id(trans_id) is None:
682
conflicts.append(('unversioned executability', trans_id))
684
if self.final_kind(trans_id) != "file":
685
conflicts.append(('non-file executability', trans_id))
688
def _overwrite_conflicts(self):
689
"""Check for overwrites (not permitted on Win32)"""
691
for trans_id in self._new_contents:
692
if self.tree_kind(trans_id) is None:
694
if trans_id not in self._removed_contents:
695
conflicts.append(('overwrite', trans_id,
696
self.final_name(trans_id)))
699
def _duplicate_entries(self, by_parent):
700
"""No directory may have two entries with the same name."""
702
if (self._new_name, self._new_parent) == ({}, {}):
704
for children in by_parent.itervalues():
706
for child_tid in children:
707
name = self.final_name(child_tid)
709
# Keep children only if they still exist in the end
710
if not self._case_sensitive_target:
712
name_ids.append((name, child_tid))
716
for name, trans_id in name_ids:
717
kind = self.final_kind(trans_id)
718
file_id = self.final_file_id(trans_id)
719
if kind is None and file_id is None:
721
if name == last_name:
722
conflicts.append(('duplicate', last_trans_id, trans_id,
725
last_trans_id = trans_id
728
def _duplicate_ids(self):
729
"""Each inventory id may only be used once"""
731
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
733
all_ids = self._tree.all_file_ids()
734
active_tree_ids = all_ids.difference(removed_tree_ids)
735
for trans_id, file_id in self._new_id.iteritems():
736
if file_id in active_tree_ids:
737
old_trans_id = self.trans_id_tree_file_id(file_id)
738
conflicts.append(('duplicate id', old_trans_id, trans_id))
741
def _parent_type_conflicts(self, by_parent):
742
"""Children must have a directory parent"""
744
for parent_id, children in by_parent.iteritems():
745
if parent_id is ROOT_PARENT:
748
for child_id in children:
749
if self.final_kind(child_id) is not None:
754
# There is at least a child, so we need an existing directory to
756
kind = self.final_kind(parent_id)
758
# The directory will be deleted
759
conflicts.append(('missing parent', parent_id))
760
elif kind != "directory":
761
# Meh, we need a *directory* to put something in it
762
conflicts.append(('non-directory parent', parent_id))
765
def _set_executability(self, path, trans_id):
766
"""Set the executability of versioned files """
767
if supports_executable():
768
new_executability = self._new_executability[trans_id]
769
abspath = self._tree.abspath(path)
770
current_mode = os.stat(abspath).st_mode
771
if new_executability:
774
to_mode = current_mode | (0100 & ~umask)
775
# Enable x-bit for others only if they can read it.
776
if current_mode & 0004:
777
to_mode |= 0001 & ~umask
778
if current_mode & 0040:
779
to_mode |= 0010 & ~umask
781
to_mode = current_mode & ~0111
782
os.chmod(abspath, to_mode)
784
def _new_entry(self, name, parent_id, file_id):
785
"""Helper function to create a new filesystem entry."""
786
trans_id = self.create_path(name, parent_id)
787
if file_id is not None:
788
self.version_file(file_id, trans_id)
791
def new_file(self, name, parent_id, contents, file_id=None,
792
executable=None, sha1=None):
793
"""Convenience method to create files.
795
name is the name of the file to create.
796
parent_id is the transaction id of the parent directory of the file.
797
contents is an iterator of bytestrings, which will be used to produce
799
:param file_id: The inventory ID of the file, if it is to be versioned.
800
:param executable: Only valid when a file_id has been supplied.
802
trans_id = self._new_entry(name, parent_id, file_id)
803
# TODO: rather than scheduling a set_executable call,
804
# have create_file create the file with the right mode.
805
self.create_file(contents, trans_id, sha1=sha1)
806
if executable is not None:
807
self.set_executability(executable, trans_id)
810
def new_directory(self, name, parent_id, file_id=None):
811
"""Convenience method to create directories.
813
name is the name of the directory to create.
814
parent_id is the transaction id of the parent directory of the
816
file_id is the inventory ID of the directory, if it is to be versioned.
818
trans_id = self._new_entry(name, parent_id, file_id)
819
self.create_directory(trans_id)
822
def new_symlink(self, name, parent_id, target, file_id=None):
823
"""Convenience method to create symbolic link.
825
name is the name of the symlink to create.
826
parent_id is the transaction id of the parent directory of the symlink.
827
target is a bytestring of the target of the symlink.
828
file_id is the inventory ID of the file, if it is to be versioned.
830
trans_id = self._new_entry(name, parent_id, file_id)
831
self.create_symlink(target, trans_id)
834
def new_orphan(self, trans_id, parent_id):
835
"""Schedule an item to be orphaned.
837
When a directory is about to be removed, its children, if they are not
838
versioned are moved out of the way: they don't have a parent anymore.
840
:param trans_id: The trans_id of the existing item.
841
:param parent_id: The parent trans_id of the item.
843
raise NotImplementedError(self.new_orphan)
845
def _get_potential_orphans(self, dir_id):
846
"""Find the potential orphans in a directory.
848
A directory can't be safely deleted if there are versioned files in it.
849
If all the contained files are unversioned then they can be orphaned.
851
The 'None' return value means that the directory contains at least one
852
versioned file and should not be deleted.
854
:param dir_id: The directory trans id.
856
:return: A list of the orphan trans ids or None if at least one
857
versioned file is present.
860
# Find the potential orphans, stop if one item should be kept
861
for child_tid in self.by_parent()[dir_id]:
862
if child_tid in self._removed_contents:
863
# The child is removed as part of the transform. Since it was
864
# versioned before, it's not an orphan
866
elif self.final_file_id(child_tid) is None:
867
# The child is not versioned
868
orphans.append(child_tid)
870
# We have a versioned file here, searching for orphans is
876
def _affected_ids(self):
877
"""Return the set of transform ids affected by the transform"""
878
trans_ids = set(self._removed_id)
879
trans_ids.update(self._new_id.keys())
880
trans_ids.update(self._removed_contents)
881
trans_ids.update(self._new_contents.keys())
882
trans_ids.update(self._new_executability.keys())
883
trans_ids.update(self._new_name.keys())
884
trans_ids.update(self._new_parent.keys())
887
def _get_file_id_maps(self):
888
"""Return mapping of file_ids to trans_ids in the to and from states"""
889
trans_ids = self._affected_ids()
892
# Build up two dicts: trans_ids associated with file ids in the
893
# FROM state, vs the TO state.
894
for trans_id in trans_ids:
895
from_file_id = self.tree_file_id(trans_id)
896
if from_file_id is not None:
897
from_trans_ids[from_file_id] = trans_id
898
to_file_id = self.final_file_id(trans_id)
899
if to_file_id is not None:
900
to_trans_ids[to_file_id] = trans_id
901
return from_trans_ids, to_trans_ids
903
def _from_file_data(self, from_trans_id, from_versioned, file_id):
904
"""Get data about a file in the from (tree) state
906
Return a (name, parent, kind, executable) tuple
908
from_path = self._tree_id_paths.get(from_trans_id)
910
# get data from working tree if versioned
911
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
912
from_name = from_entry.name
913
from_parent = from_entry.parent_id
916
if from_path is None:
917
# File does not exist in FROM state
921
# File exists, but is not versioned. Have to use path-
923
from_name = os.path.basename(from_path)
924
tree_parent = self.get_tree_parent(from_trans_id)
925
from_parent = self.tree_file_id(tree_parent)
926
if from_path is not None:
927
from_kind, from_executable, from_stats = \
928
self._tree._comparison_data(from_entry, from_path)
931
from_executable = False
932
return from_name, from_parent, from_kind, from_executable
934
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
935
"""Get data about a file in the to (target) state
937
Return a (name, parent, kind, executable) tuple
939
to_name = self.final_name(to_trans_id)
940
to_kind = self.final_kind(to_trans_id)
941
to_parent = self.final_file_id(self.final_parent(to_trans_id))
942
if to_trans_id in self._new_executability:
943
to_executable = self._new_executability[to_trans_id]
944
elif to_trans_id == from_trans_id:
945
to_executable = from_executable
947
to_executable = False
948
return to_name, to_parent, to_kind, to_executable
950
def iter_changes(self):
951
"""Produce output in the same format as Tree.iter_changes.
953
Will produce nonsensical results if invoked while inventory/filesystem
954
conflicts (as reported by TreeTransform.find_conflicts()) are present.
956
This reads the Transform, but only reproduces changes involving a
957
file_id. Files that are not versioned in either of the FROM or TO
958
states are not reflected.
960
final_paths = FinalPaths(self)
961
from_trans_ids, to_trans_ids = self._get_file_id_maps()
963
# Now iterate through all active file_ids
964
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
966
from_trans_id = from_trans_ids.get(file_id)
967
# find file ids, and determine versioning state
968
if from_trans_id is None:
969
from_versioned = False
970
from_trans_id = to_trans_ids[file_id]
972
from_versioned = True
973
to_trans_id = to_trans_ids.get(file_id)
974
if to_trans_id is None:
976
to_trans_id = from_trans_id
980
from_name, from_parent, from_kind, from_executable = \
981
self._from_file_data(from_trans_id, from_versioned, file_id)
983
to_name, to_parent, to_kind, to_executable = \
984
self._to_file_data(to_trans_id, from_trans_id, from_executable)
986
if not from_versioned:
989
from_path = self._tree_id_paths.get(from_trans_id)
993
to_path = final_paths.get_path(to_trans_id)
994
if from_kind != to_kind:
996
elif to_kind in ('file', 'symlink') and (
997
to_trans_id != from_trans_id or
998
to_trans_id in self._new_contents):
1000
if (not modified and from_versioned == to_versioned and
1001
from_parent==to_parent and from_name == to_name and
1002
from_executable == to_executable):
1004
results.append((file_id, (from_path, to_path), modified,
1005
(from_versioned, to_versioned),
1006
(from_parent, to_parent),
1007
(from_name, to_name),
1008
(from_kind, to_kind),
1009
(from_executable, to_executable)))
1010
return iter(sorted(results, key=lambda x:x[1]))
1012
def get_preview_tree(self):
1013
"""Return a tree representing the result of the transform.
1015
The tree is a snapshot, and altering the TreeTransform will invalidate
1018
return _PreviewTree(self)
1020
def commit(self, branch, message, merge_parents=None, strict=False,
1021
timestamp=None, timezone=None, committer=None, authors=None,
1022
revprops=None, revision_id=None):
1023
"""Commit the result of this TreeTransform to a branch.
1025
:param branch: The branch to commit to.
1026
:param message: The message to attach to the commit.
1027
:param merge_parents: Additional parent revision-ids specified by
1029
:param strict: If True, abort the commit if there are unversioned
1031
:param timestamp: if not None, seconds-since-epoch for the time and
1032
date. (May be a float.)
1033
:param timezone: Optional timezone for timestamp, as an offset in
1035
:param committer: Optional committer in email-id format.
1036
(e.g. "J Random Hacker <jrandom@example.com>")
1037
:param authors: Optional list of authors in email-id format.
1038
:param revprops: Optional dictionary of revision properties.
1039
:param revision_id: Optional revision id. (Specifying a revision-id
1040
may reduce performance for some non-native formats.)
1041
:return: The revision_id of the revision committed.
1043
self._check_malformed()
1045
unversioned = set(self._new_contents).difference(set(self._new_id))
1046
for trans_id in unversioned:
1047
if self.final_file_id(trans_id) is None:
1048
raise errors.StrictCommitFailed()
1050
revno, last_rev_id = branch.last_revision_info()
1051
if last_rev_id == _mod_revision.NULL_REVISION:
1052
if merge_parents is not None:
1053
raise ValueError('Cannot supply merge parents for first'
1057
parent_ids = [last_rev_id]
1058
if merge_parents is not None:
1059
parent_ids.extend(merge_parents)
1060
if self._tree.get_revision_id() != last_rev_id:
1061
raise ValueError('TreeTransform not based on branch basis: %s' %
1062
self._tree.get_revision_id())
1063
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1064
builder = branch.get_commit_builder(parent_ids,
1065
timestamp=timestamp,
1067
committer=committer,
1069
revision_id=revision_id)
1070
preview = self.get_preview_tree()
1071
list(builder.record_iter_changes(preview, last_rev_id,
1072
self.iter_changes()))
1073
builder.finish_inventory()
1074
revision_id = builder.commit(message)
1075
branch.set_last_revision_info(revno + 1, revision_id)
1078
def _text_parent(self, trans_id):
1079
file_id = self.tree_file_id(trans_id)
1081
if file_id is None or self._tree.kind(file_id) != 'file':
1083
except errors.NoSuchFile:
1087
def _get_parents_texts(self, trans_id):
1088
"""Get texts for compression parents of this file."""
1089
file_id = self._text_parent(trans_id)
1092
return (self._tree.get_file_text(file_id),)
1094
def _get_parents_lines(self, trans_id):
1095
"""Get lines for compression parents of this file."""
1096
file_id = self._text_parent(trans_id)
1099
return (self._tree.get_file_lines(file_id),)
1101
def serialize(self, serializer):
1102
"""Serialize this TreeTransform.
1104
:param serializer: A Serialiser like pack.ContainerSerializer.
1106
new_name = dict((k, v.encode('utf-8')) for k, v in
1107
self._new_name.items())
1108
new_executability = dict((k, int(v)) for k, v in
1109
self._new_executability.items())
1110
tree_path_ids = dict((k.encode('utf-8'), v)
1111
for k, v in self._tree_path_ids.items())
1113
'_id_number': self._id_number,
1114
'_new_name': new_name,
1115
'_new_parent': self._new_parent,
1116
'_new_executability': new_executability,
1117
'_new_id': self._new_id,
1118
'_tree_path_ids': tree_path_ids,
1119
'_removed_id': list(self._removed_id),
1120
'_removed_contents': list(self._removed_contents),
1121
'_non_present_ids': self._non_present_ids,
1123
yield serializer.bytes_record(bencode.bencode(attribs),
1125
for trans_id, kind in self._new_contents.items():
1127
lines = osutils.chunks_to_lines(
1128
self._read_file_chunks(trans_id))
1129
parents = self._get_parents_lines(trans_id)
1130
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1131
content = ''.join(mpdiff.to_patch())
1132
if kind == 'directory':
1134
if kind == 'symlink':
1135
content = self._read_symlink_target(trans_id)
1136
yield serializer.bytes_record(content, ((trans_id, kind),))
1138
def deserialize(self, records):
1139
"""Deserialize a stored TreeTransform.
1141
:param records: An iterable of (names, content) tuples, as per
1142
pack.ContainerPushParser.
1144
names, content = records.next()
1145
attribs = bencode.bdecode(content)
1146
self._id_number = attribs['_id_number']
1147
self._new_name = dict((k, v.decode('utf-8'))
1148
for k, v in attribs['_new_name'].items())
1149
self._new_parent = attribs['_new_parent']
1150
self._new_executability = dict((k, bool(v)) for k, v in
1151
attribs['_new_executability'].items())
1152
self._new_id = attribs['_new_id']
1153
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1154
self._tree_path_ids = {}
1155
self._tree_id_paths = {}
1156
for bytepath, trans_id in attribs['_tree_path_ids'].items():
1157
path = bytepath.decode('utf-8')
1158
self._tree_path_ids[path] = trans_id
1159
self._tree_id_paths[trans_id] = path
1160
self._removed_id = set(attribs['_removed_id'])
1161
self._removed_contents = set(attribs['_removed_contents'])
1162
self._non_present_ids = attribs['_non_present_ids']
1163
for ((trans_id, kind),), content in records:
1165
mpdiff = multiparent.MultiParent.from_patch(content)
1166
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1167
self.create_file(lines, trans_id)
1168
if kind == 'directory':
1169
self.create_directory(trans_id)
1170
if kind == 'symlink':
1171
self.create_symlink(content.decode('utf-8'), trans_id)
1174
class DiskTreeTransform(TreeTransformBase):
1175
"""Tree transform storing its contents on disk."""
1177
def __init__(self, tree, limbodir, pb=None,
1178
case_sensitive=True):
1180
:param tree: The tree that will be transformed, but not necessarily
1182
:param limbodir: A directory where new files can be stored until
1183
they are installed in their proper places
1185
:param case_sensitive: If True, the target of the transform is
1186
case sensitive, not just case preserving.
1188
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1189
self._limbodir = limbodir
1190
self._deletiondir = None
1191
# A mapping of transform ids to their limbo filename
1192
self._limbo_files = {}
1193
self._possibly_stale_limbo_files = set()
1194
# A mapping of transform ids to a set of the transform ids of children
1195
# that their limbo directory has
1196
self._limbo_children = {}
1197
# Map transform ids to maps of child filename to child transform id
1198
self._limbo_children_names = {}
1199
# List of transform ids that need to be renamed from limbo into place
1200
self._needs_rename = set()
1201
self._creation_mtime = None
1204
"""Release the working tree lock, if held, clean up limbo dir.
1206
This is required if apply has not been invoked, but can be invoked
1209
if self._tree is None:
1212
limbo_paths = self._limbo_files.values() + list(
1213
self._possibly_stale_limbo_files)
1214
limbo_paths = sorted(limbo_paths, reverse=True)
1215
for path in limbo_paths:
1219
if e.errno != errno.ENOENT:
1221
# XXX: warn? perhaps we just got interrupted at an
1222
# inconvenient moment, but perhaps files are disappearing
1225
delete_any(self._limbodir)
1227
# We don't especially care *why* the dir is immortal.
1228
raise ImmortalLimbo(self._limbodir)
1230
if self._deletiondir is not None:
1231
delete_any(self._deletiondir)
1233
raise errors.ImmortalPendingDeletion(self._deletiondir)
1235
TreeTransformBase.finalize(self)
1237
def _limbo_name(self, trans_id):
1238
"""Generate the limbo name of a file"""
1239
limbo_name = self._limbo_files.get(trans_id)
1240
if limbo_name is None:
1241
limbo_name = self._generate_limbo_path(trans_id)
1242
self._limbo_files[trans_id] = limbo_name
1245
def _generate_limbo_path(self, trans_id):
1246
"""Generate a limbo path using the trans_id as the relative path.
1248
This is suitable as a fallback, and when the transform should not be
1249
sensitive to the path encoding of the limbo directory.
1251
self._needs_rename.add(trans_id)
1252
return pathjoin(self._limbodir, trans_id)
1254
def adjust_path(self, name, parent, trans_id):
1255
previous_parent = self._new_parent.get(trans_id)
1256
previous_name = self._new_name.get(trans_id)
1257
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1258
if (trans_id in self._limbo_files and
1259
trans_id not in self._needs_rename):
1260
self._rename_in_limbo([trans_id])
1261
if previous_parent != parent:
1262
self._limbo_children[previous_parent].remove(trans_id)
1263
if previous_parent != parent or previous_name != name:
1264
del self._limbo_children_names[previous_parent][previous_name]
1266
def _rename_in_limbo(self, trans_ids):
1267
"""Fix limbo names so that the right final path is produced.
1269
This means we outsmarted ourselves-- we tried to avoid renaming
1270
these files later by creating them with their final names in their
1271
final parents. But now the previous name or parent is no longer
1272
suitable, so we have to rename them.
1274
Even for trans_ids that have no new contents, we must remove their
1275
entries from _limbo_files, because they are now stale.
1277
for trans_id in trans_ids:
1278
old_path = self._limbo_files[trans_id]
1279
self._possibly_stale_limbo_files.add(old_path)
1280
del self._limbo_files[trans_id]
1281
if trans_id not in self._new_contents:
1283
new_path = self._limbo_name(trans_id)
1284
os.rename(old_path, new_path)
1285
self._possibly_stale_limbo_files.remove(old_path)
1286
for descendant in self._limbo_descendants(trans_id):
1287
desc_path = self._limbo_files[descendant]
1288
desc_path = new_path + desc_path[len(old_path):]
1289
self._limbo_files[descendant] = desc_path
1291
def _limbo_descendants(self, trans_id):
1292
"""Return the set of trans_ids whose limbo paths descend from this."""
1293
descendants = set(self._limbo_children.get(trans_id, []))
1294
for descendant in list(descendants):
1295
descendants.update(self._limbo_descendants(descendant))
1298
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1299
"""Schedule creation of a new file.
1303
:param contents: an iterator of strings, all of which will be written
1304
to the target destination.
1305
:param trans_id: TreeTransform handle
1306
:param mode_id: If not None, force the mode of the target file to match
1307
the mode of the object referenced by mode_id.
1308
Otherwise, we will try to preserve mode bits of an existing file.
1309
:param sha1: If the sha1 of this content is already known, pass it in.
1310
We can use it to prevent future sha1 computations.
1312
name = self._limbo_name(trans_id)
1313
f = open(name, 'wb')
1315
unique_add(self._new_contents, trans_id, 'file')
1316
f.writelines(contents)
1319
self._set_mtime(name)
1320
self._set_mode(trans_id, mode_id, S_ISREG)
1321
# It is unfortunate we have to use lstat instead of fstat, but we just
1322
# used utime and chmod on the file, so we need the accurate final
1324
if sha1 is not None:
1325
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1327
def _read_file_chunks(self, trans_id):
1328
cur_file = open(self._limbo_name(trans_id), 'rb')
1330
return cur_file.readlines()
1334
def _read_symlink_target(self, trans_id):
1335
return os.readlink(self._limbo_name(trans_id))
1337
def _set_mtime(self, path):
1338
"""All files that are created get the same mtime.
1340
This time is set by the first object to be created.
1342
if self._creation_mtime is None:
1343
self._creation_mtime = time.time()
1344
os.utime(path, (self._creation_mtime, self._creation_mtime))
1346
def create_hardlink(self, path, trans_id):
1347
"""Schedule creation of a hard link"""
1348
name = self._limbo_name(trans_id)
1352
if e.errno != errno.EPERM:
1354
raise errors.HardLinkNotSupported(path)
1356
unique_add(self._new_contents, trans_id, 'file')
1358
# Clean up the file, it never got registered so
1359
# TreeTransform.finalize() won't clean it up.
1363
def create_directory(self, trans_id):
1364
"""Schedule creation of a new directory.
1366
See also new_directory.
1368
os.mkdir(self._limbo_name(trans_id))
1369
unique_add(self._new_contents, trans_id, 'directory')
1371
def create_symlink(self, target, trans_id):
1372
"""Schedule creation of a new symbolic link.
1374
target is a bytestring.
1375
See also new_symlink.
1378
os.symlink(target, self._limbo_name(trans_id))
1379
unique_add(self._new_contents, trans_id, 'symlink')
1382
path = FinalPaths(self).get_path(trans_id)
1385
raise UnableCreateSymlink(path=path)
1387
def cancel_creation(self, trans_id):
1388
"""Cancel the creation of new file contents."""
1389
del self._new_contents[trans_id]
1390
if trans_id in self._observed_sha1s:
1391
del self._observed_sha1s[trans_id]
1392
children = self._limbo_children.get(trans_id)
1393
# if this is a limbo directory with children, move them before removing
1395
if children is not None:
1396
self._rename_in_limbo(children)
1397
del self._limbo_children[trans_id]
1398
del self._limbo_children_names[trans_id]
1399
delete_any(self._limbo_name(trans_id))
1401
def new_orphan(self, trans_id, parent_id):
1402
# FIXME: There is no tree config, so we use the branch one (it's weird
1403
# to define it this way as orphaning can only occur in a working tree,
1404
# but that's all we have (for now). It will find the option in
1405
# locations.conf or bazaar.conf though) -- vila 20100916
1406
conf = self._tree.branch.get_config()
1407
conf_var_name = 'bzr.transform.orphan_policy'
1408
orphan_policy = conf.get_user_option(conf_var_name)
1409
default_policy = orphaning_registry.default_key
1410
if orphan_policy is None:
1411
orphan_policy = default_policy
1412
if orphan_policy not in orphaning_registry:
1413
trace.warning('%s (from %s) is not a known policy, defaulting '
1414
'to %s' % (orphan_policy, conf_var_name, default_policy))
1415
orphan_policy = default_policy
1416
handle_orphan = orphaning_registry.get(orphan_policy)
1417
handle_orphan(self, trans_id, parent_id)
1420
class OrphaningError(errors.BzrError):
1422
# Only bugs could lead to such exception being seen by the user
1423
internal_error = True
1424
_fmt = "Error while orphaning %s in %s directory"
1426
def __init__(self, orphan, parent):
1427
errors.BzrError.__init__(self)
1428
self.orphan = orphan
1429
self.parent = parent
1432
class OrphaningForbidden(OrphaningError):
1434
_fmt = "Policy: %s doesn't allow creating orphans."
1436
def __init__(self, policy):
1437
errors.BzrError.__init__(self)
1438
self.policy = policy
1441
def move_orphan(tt, orphan_id, parent_id):
1442
"""See TreeTransformBase.new_orphan.
1444
This creates a new orphan in the `bzr-orphans` dir at the root of the
1447
:param tt: The TreeTransform orphaning `trans_id`.
1449
:param orphan_id: The trans id that should be orphaned.
1451
:param parent_id: The orphan parent trans id.
1453
# Add the orphan dir if it doesn't exist
1454
orphan_dir_basename = 'bzr-orphans'
1455
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1456
if tt.final_kind(od_id) is None:
1457
tt.create_directory(od_id)
1458
parent_path = tt._tree_id_paths[parent_id]
1459
# Find a name that doesn't exist yet in the orphan dir
1460
actual_name = tt.final_name(orphan_id)
1461
new_name = tt._available_backup_name(actual_name, od_id)
1462
tt.adjust_path(new_name, od_id, orphan_id)
1463
trace.warning('%s has been orphaned in %s'
1464
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1467
def refuse_orphan(tt, orphan_id, parent_id):
1468
"""See TreeTransformBase.new_orphan.
1470
This refuses to create orphan, letting the caller handle the conflict.
1472
raise OrphaningForbidden('never')
1475
orphaning_registry = registry.Registry()
1476
orphaning_registry.register(
1477
'conflict', refuse_orphan,
1478
'Leave orphans in place and create a conflict on the directory.')
1479
orphaning_registry.register(
1480
'move', move_orphan,
1481
'Move orphans into the bzr-orphans directory.')
1482
orphaning_registry._set_default_key('conflict')
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'))
1564
if e.errno == errno.EEXIST:
1565
raise ExistingLimbo(limbodir)
1566
deletiondir = urlutils.local_path_from_url(
1567
tree._transport.abspath('pending-deletion'))
1569
os.mkdir(deletiondir)
1571
if e.errno == errno.EEXIST:
1572
raise errors.ExistingPendingDeletion(deletiondir)
1577
# Cache of realpath results, to speed up canonical_path
1578
self._realpaths = {}
1579
# Cache of relpath results, to speed up canonical_path
1581
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1582
tree.case_sensitive)
1583
self._deletiondir = deletiondir
1585
def canonical_path(self, path):
1586
"""Get the canonical tree-relative path"""
1587
# don't follow final symlinks
1588
abs = self._tree.abspath(path)
1589
if abs in self._relpaths:
1590
return self._relpaths[abs]
1591
dirname, basename = os.path.split(abs)
1592
if dirname not in self._realpaths:
1593
self._realpaths[dirname] = os.path.realpath(dirname)
1594
dirname = self._realpaths[dirname]
1595
abs = pathjoin(dirname, basename)
1596
if dirname in self._relpaths:
1597
relpath = pathjoin(self._relpaths[dirname], basename)
1598
relpath = relpath.rstrip('/\\')
1600
relpath = self._tree.relpath(abs)
1601
self._relpaths[abs] = relpath
1604
def tree_kind(self, trans_id):
1605
"""Determine the file kind in the working tree.
1607
:returns: The file kind or None if the file does not exist
1609
path = self._tree_id_paths.get(trans_id)
1613
return file_kind(self._tree.abspath(path))
1614
except errors.NoSuchFile:
1617
def _set_mode(self, trans_id, mode_id, typefunc):
1618
"""Set the mode of new file contents.
1619
The mode_id is the existing file to get the mode from (often the same
1620
as trans_id). The operation is only performed if there's a mode match
1621
according to typefunc.
1626
old_path = self._tree_id_paths[mode_id]
1630
mode = os.stat(self._tree.abspath(old_path)).st_mode
1632
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1633
# Either old_path doesn't exist, or the parent of the
1634
# target is not a directory (but will be one eventually)
1635
# Either way, we know it doesn't exist *right now*
1636
# See also bug #248448
1641
os.chmod(self._limbo_name(trans_id), mode)
1643
def iter_tree_children(self, parent_id):
1644
"""Iterate through the entry's tree children, if any"""
1646
path = self._tree_id_paths[parent_id]
1650
children = os.listdir(self._tree.abspath(path))
1652
if not (osutils._is_error_enotdir(e)
1653
or e.errno in (errno.ENOENT, errno.ESRCH)):
1657
for child in children:
1658
childpath = joinpath(path, child)
1659
if self._tree.is_control_filename(childpath):
1661
yield self.trans_id_tree_path(childpath)
1663
def _generate_limbo_path(self, trans_id):
1664
"""Generate a limbo path using the final path if possible.
1666
This optimizes the performance of applying the tree transform by
1667
avoiding renames. These renames can be avoided only when the parent
1668
directory is already scheduled for creation.
1670
If the final path cannot be used, falls back to using the trans_id as
1673
parent = self._new_parent.get(trans_id)
1674
# if the parent directory is already in limbo (e.g. when building a
1675
# tree), choose a limbo name inside the parent, to reduce further
1677
use_direct_path = False
1678
if self._new_contents.get(parent) == 'directory':
1679
filename = self._new_name.get(trans_id)
1680
if filename is not None:
1681
if parent not in self._limbo_children:
1682
self._limbo_children[parent] = set()
1683
self._limbo_children_names[parent] = {}
1684
use_direct_path = True
1685
# the direct path can only be used if no other file has
1686
# already taken this pathname, i.e. if the name is unused, or
1687
# if it is already associated with this trans_id.
1688
elif self._case_sensitive_target:
1689
if (self._limbo_children_names[parent].get(filename)
1690
in (trans_id, None)):
1691
use_direct_path = True
1693
for l_filename, l_trans_id in\
1694
self._limbo_children_names[parent].iteritems():
1695
if l_trans_id == trans_id:
1697
if l_filename.lower() == filename.lower():
1700
use_direct_path = True
1702
if not use_direct_path:
1703
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1705
limbo_name = pathjoin(self._limbo_files[parent], filename)
1706
self._limbo_children[parent].add(trans_id)
1707
self._limbo_children_names[parent][filename] = trans_id
1711
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1712
"""Apply all changes to the inventory and filesystem.
1714
If filesystem or inventory conflicts are present, MalformedTransform
1717
If apply succeeds, finalize is not necessary.
1719
:param no_conflicts: if True, the caller guarantees there are no
1720
conflicts, so no check is made.
1721
:param precomputed_delta: An inventory delta to use instead of
1723
:param _mover: Supply an alternate FileMover, for testing
1725
if not no_conflicts:
1726
self._check_malformed()
1727
child_pb = ui.ui_factory.nested_progress_bar()
1729
if precomputed_delta is None:
1730
child_pb.update(gettext('Apply phase'), 0, 2)
1731
inventory_delta = self._generate_inventory_delta()
1734
inventory_delta = precomputed_delta
1737
mover = _FileMover()
1741
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1742
self._apply_removals(mover)
1743
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1744
modified_paths = self._apply_insertions(mover)
1749
mover.apply_deletions()
1752
if self.final_file_id(self.root) is None:
1753
inventory_delta = [e for e in inventory_delta if e[0] != '']
1754
self._tree.apply_inventory_delta(inventory_delta)
1755
self._apply_observed_sha1s()
1758
return _TransformResults(modified_paths, self.rename_count)
1760
def _generate_inventory_delta(self):
1761
"""Generate an inventory delta for the current transform."""
1762
inventory_delta = []
1763
child_pb = ui.ui_factory.nested_progress_bar()
1764
new_paths = self._inventory_altered()
1765
total_entries = len(new_paths) + len(self._removed_id)
1767
for num, trans_id in enumerate(self._removed_id):
1769
child_pb.update(gettext('removing file'), num, total_entries)
1770
if trans_id == self._new_root:
1771
file_id = self._tree.get_root_id()
1773
file_id = self.tree_file_id(trans_id)
1774
# File-id isn't really being deleted, just moved
1775
if file_id in self._r_new_id:
1777
path = self._tree_id_paths[trans_id]
1778
inventory_delta.append((path, None, file_id, None))
1779
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1781
entries = self._tree.iter_entries_by_dir(
1782
new_path_file_ids.values())
1783
old_paths = dict((e.file_id, p) for p, e in entries)
1785
for num, (path, trans_id) in enumerate(new_paths):
1787
child_pb.update(gettext('adding file'),
1788
num + len(self._removed_id), total_entries)
1789
file_id = new_path_file_ids[trans_id]
1793
kind = self.final_kind(trans_id)
1795
kind = self._tree.stored_kind(file_id)
1796
parent_trans_id = self.final_parent(trans_id)
1797
parent_file_id = new_path_file_ids.get(parent_trans_id)
1798
if parent_file_id is None:
1799
parent_file_id = self.final_file_id(parent_trans_id)
1800
if trans_id in self._new_reference_revision:
1801
new_entry = inventory.TreeReference(
1803
self._new_name[trans_id],
1804
self.final_file_id(self._new_parent[trans_id]),
1805
None, self._new_reference_revision[trans_id])
1807
new_entry = inventory.make_entry(kind,
1808
self.final_name(trans_id),
1809
parent_file_id, file_id)
1810
old_path = old_paths.get(new_entry.file_id)
1811
new_executability = self._new_executability.get(trans_id)
1812
if new_executability is not None:
1813
new_entry.executable = new_executability
1814
inventory_delta.append(
1815
(old_path, path, new_entry.file_id, new_entry))
1818
return inventory_delta
1820
def _apply_removals(self, mover):
1821
"""Perform tree operations that remove directory/inventory names.
1823
That is, delete files that are to be deleted, and put any files that
1824
need renaming into limbo. This must be done in strict child-to-parent
1827
If inventory_delta is None, no inventory delta generation is performed.
1829
tree_paths = list(self._tree_path_ids.iteritems())
1830
tree_paths.sort(reverse=True)
1831
child_pb = ui.ui_factory.nested_progress_bar()
1833
for num, (path, trans_id) in enumerate(tree_paths):
1834
# do not attempt to move root into a subdirectory of itself.
1837
child_pb.update(gettext('removing file'), num, len(tree_paths))
1838
full_path = self._tree.abspath(path)
1839
if trans_id in self._removed_contents:
1840
delete_path = os.path.join(self._deletiondir, trans_id)
1841
mover.pre_delete(full_path, delete_path)
1842
elif (trans_id in self._new_name
1843
or trans_id in self._new_parent):
1845
mover.rename(full_path, self._limbo_name(trans_id))
1846
except errors.TransformRenameFailed, e:
1847
if e.errno != errno.ENOENT:
1850
self.rename_count += 1
1854
def _apply_insertions(self, mover):
1855
"""Perform tree operations that insert directory/inventory names.
1857
That is, create any files that need to be created, and restore from
1858
limbo any files that needed renaming. This must be done in strict
1859
parent-to-child order.
1861
If inventory_delta is None, no inventory delta is calculated, and
1862
no list of modified paths is returned.
1864
new_paths = self.new_paths(filesystem_only=True)
1866
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1868
child_pb = ui.ui_factory.nested_progress_bar()
1870
for num, (path, trans_id) in enumerate(new_paths):
1872
child_pb.update(gettext('adding file'), num, len(new_paths))
1873
full_path = self._tree.abspath(path)
1874
if trans_id in self._needs_rename:
1876
mover.rename(self._limbo_name(trans_id), full_path)
1877
except errors.TransformRenameFailed, e:
1878
# We may be renaming a dangling inventory id
1879
if e.errno != errno.ENOENT:
1882
self.rename_count += 1
1883
# TODO: if trans_id in self._observed_sha1s, we should
1884
# re-stat the final target, since ctime will be
1885
# updated by the change.
1886
if (trans_id in self._new_contents or
1887
self.path_changed(trans_id)):
1888
if trans_id in self._new_contents:
1889
modified_paths.append(full_path)
1890
if trans_id in self._new_executability:
1891
self._set_executability(path, trans_id)
1892
if trans_id in self._observed_sha1s:
1893
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1894
st = osutils.lstat(full_path)
1895
self._observed_sha1s[trans_id] = (o_sha1, st)
1898
for path, trans_id in new_paths:
1899
# new_paths includes stuff like workingtree conflicts. Only the
1900
# stuff in new_contents actually comes from limbo.
1901
if trans_id in self._limbo_files:
1902
del self._limbo_files[trans_id]
1903
self._new_contents.clear()
1904
return modified_paths
1906
def _apply_observed_sha1s(self):
1907
"""After we have finished renaming everything, update observed sha1s
1909
This has to be done after self._tree.apply_inventory_delta, otherwise
1910
it doesn't know anything about the files we are updating. Also, we want
1911
to do this as late as possible, so that most entries end up cached.
1913
# TODO: this doesn't update the stat information for directories. So
1914
# the first 'bzr status' will still need to rewrite
1915
# .bzr/checkout/dirstate. However, we at least don't need to
1916
# re-read all of the files.
1917
# TODO: If the operation took a while, we could do a time.sleep(3) here
1918
# to allow the clock to tick over and ensure we won't have any
1919
# problems. (we could observe start time, and finish time, and if
1920
# it is less than eg 10% overhead, add a sleep call.)
1921
paths = FinalPaths(self)
1922
for trans_id, observed in self._observed_sha1s.iteritems():
1923
path = paths.get_path(trans_id)
1924
# We could get the file_id, but dirstate prefers to use the path
1925
# anyway, and it is 'cheaper' to determine.
1926
# file_id = self._new_id[trans_id]
1927
self._tree._observed_sha1(None, path, observed)
1930
class TransformPreview(DiskTreeTransform):
1931
"""A TreeTransform for generating preview trees.
1933
Unlike TreeTransform, this version works when the input tree is a
1934
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1935
unversioned files in the input tree.
1938
def __init__(self, tree, pb=None, case_sensitive=True):
1940
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1941
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1943
def canonical_path(self, path):
1946
def tree_kind(self, trans_id):
1947
path = self._tree_id_paths.get(trans_id)
1950
kind = self._tree.path_content_summary(path)[0]
1951
if kind == 'missing':
1955
def _set_mode(self, trans_id, mode_id, typefunc):
1956
"""Set the mode of new file contents.
1957
The mode_id is the existing file to get the mode from (often the same
1958
as trans_id). The operation is only performed if there's a mode match
1959
according to typefunc.
1961
# is it ok to ignore this? probably
1964
def iter_tree_children(self, parent_id):
1965
"""Iterate through the entry's tree children, if any"""
1967
path = self._tree_id_paths[parent_id]
1970
file_id = self.tree_file_id(parent_id)
1973
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1974
children = getattr(entry, 'children', {})
1975
for child in children:
1976
childpath = joinpath(path, child)
1977
yield self.trans_id_tree_path(childpath)
1979
def new_orphan(self, trans_id, parent_id):
1980
raise NotImplementedError(self.new_orphan)
1983
class _PreviewTree(tree.InventoryTree):
1984
"""Partial implementation of Tree to support show_diff_trees"""
1986
def __init__(self, transform):
1987
self._transform = transform
1988
self._final_paths = FinalPaths(transform)
1989
self.__by_parent = None
1990
self._parent_ids = []
1991
self._all_children_cache = {}
1992
self._path2trans_id_cache = {}
1993
self._final_name_cache = {}
1994
self._iter_changes_cache = dict((c[0], c) for c in
1995
self._transform.iter_changes())
1997
def _content_change(self, file_id):
1998
"""Return True if the content of this file changed"""
1999
changes = self._iter_changes_cache.get(file_id)
2000
# changes[2] is true if the file content changed. See
2001
# InterTree.iter_changes.
2002
return (changes is not None and changes[2])
2004
def _get_repository(self):
2005
repo = getattr(self._transform._tree, '_repository', None)
2007
repo = self._transform._tree.branch.repository
2010
def _iter_parent_trees(self):
2011
for revision_id in self.get_parent_ids():
2013
yield self.revision_tree(revision_id)
2014
except errors.NoSuchRevisionInTree:
2015
yield self._get_repository().revision_tree(revision_id)
2017
def _get_file_revision(self, file_id, vf, tree_revision):
2018
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2019
self._iter_parent_trees()]
2020
vf.add_lines((file_id, tree_revision), parent_keys,
2021
self.get_file_lines(file_id))
2022
repo = self._get_repository()
2023
base_vf = repo.texts
2024
if base_vf not in vf.fallback_versionedfiles:
2025
vf.fallback_versionedfiles.append(base_vf)
2026
return tree_revision
2028
def _stat_limbo_file(self, file_id=None, trans_id=None):
2029
if trans_id is None:
2030
trans_id = self._transform.trans_id_file_id(file_id)
2031
name = self._transform._limbo_name(trans_id)
2032
return os.lstat(name)
2035
def _by_parent(self):
2036
if self.__by_parent is None:
2037
self.__by_parent = self._transform.by_parent()
2038
return self.__by_parent
2040
def _comparison_data(self, entry, path):
2041
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2042
if kind == 'missing':
2046
file_id = self._transform.final_file_id(self._path2trans_id(path))
2047
executable = self.is_executable(file_id, path)
2048
return kind, executable, None
2050
def is_locked(self):
2053
def lock_read(self):
2054
# Perhaps in theory, this should lock the TreeTransform?
2061
def inventory(self):
2062
"""This Tree does not use inventory as its backing data."""
2063
raise NotImplementedError(_PreviewTree.inventory)
2065
def get_root_id(self):
2066
return self._transform.final_file_id(self._transform.root)
2068
def all_file_ids(self):
2069
tree_ids = set(self._transform._tree.all_file_ids())
2070
tree_ids.difference_update(self._transform.tree_file_id(t)
2071
for t in self._transform._removed_id)
2072
tree_ids.update(self._transform._new_id.values())
2076
return iter(self.all_file_ids())
2078
def _has_id(self, file_id, fallback_check):
2079
if file_id in self._transform._r_new_id:
2081
elif file_id in set([self._transform.tree_file_id(trans_id) for
2082
trans_id in self._transform._removed_id]):
2085
return fallback_check(file_id)
2087
def has_id(self, file_id):
2088
return self._has_id(file_id, self._transform._tree.has_id)
2090
def has_or_had_id(self, file_id):
2091
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2093
def _path2trans_id(self, path):
2094
# We must not use None here, because that is a valid value to store.
2095
trans_id = self._path2trans_id_cache.get(path, object)
2096
if trans_id is not object:
2098
segments = splitpath(path)
2099
cur_parent = self._transform.root
2100
for cur_segment in segments:
2101
for child in self._all_children(cur_parent):
2102
final_name = self._final_name_cache.get(child)
2103
if final_name is None:
2104
final_name = self._transform.final_name(child)
2105
self._final_name_cache[child] = final_name
2106
if final_name == cur_segment:
2110
self._path2trans_id_cache[path] = None
2112
self._path2trans_id_cache[path] = cur_parent
2115
def path2id(self, path):
2116
return self._transform.final_file_id(self._path2trans_id(path))
2118
def id2path(self, file_id):
2119
trans_id = self._transform.trans_id_file_id(file_id)
2121
return self._final_paths._determine_path(trans_id)
2123
raise errors.NoSuchId(self, file_id)
2125
def _all_children(self, trans_id):
2126
children = self._all_children_cache.get(trans_id)
2127
if children is not None:
2129
children = set(self._transform.iter_tree_children(trans_id))
2130
# children in the _new_parent set are provided by _by_parent.
2131
children.difference_update(self._transform._new_parent.keys())
2132
children.update(self._by_parent.get(trans_id, []))
2133
self._all_children_cache[trans_id] = children
2136
def iter_children(self, file_id):
2137
trans_id = self._transform.trans_id_file_id(file_id)
2138
for child_trans_id in self._all_children(trans_id):
2139
yield self._transform.final_file_id(child_trans_id)
2142
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2143
in self._transform._tree.extras())
2144
possible_extras.update(self._transform._new_contents)
2145
possible_extras.update(self._transform._removed_id)
2146
for trans_id in possible_extras:
2147
if self._transform.final_file_id(trans_id) is None:
2148
yield self._final_paths._determine_path(trans_id)
2150
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2151
yield_parents=False):
2152
for trans_id, parent_file_id in ordered_entries:
2153
file_id = self._transform.final_file_id(trans_id)
2156
if (specific_file_ids is not None
2157
and file_id not in specific_file_ids):
2159
kind = self._transform.final_kind(trans_id)
2161
kind = self._transform._tree.stored_kind(file_id)
2162
new_entry = inventory.make_entry(
2164
self._transform.final_name(trans_id),
2165
parent_file_id, file_id)
2166
yield new_entry, trans_id
2168
def _list_files_by_dir(self):
2169
todo = [ROOT_PARENT]
2171
while len(todo) > 0:
2173
parent_file_id = self._transform.final_file_id(parent)
2174
children = list(self._all_children(parent))
2175
paths = dict(zip(children, self._final_paths.get_paths(children)))
2176
children.sort(key=paths.get)
2177
todo.extend(reversed(children))
2178
for trans_id in children:
2179
ordered_ids.append((trans_id, parent_file_id))
2182
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2183
# This may not be a maximally efficient implementation, but it is
2184
# reasonably straightforward. An implementation that grafts the
2185
# TreeTransform changes onto the tree's iter_entries_by_dir results
2186
# might be more efficient, but requires tricky inferences about stack
2188
ordered_ids = self._list_files_by_dir()
2189
for entry, trans_id in self._make_inv_entries(ordered_ids,
2190
specific_file_ids, yield_parents=yield_parents):
2191
yield unicode(self._final_paths.get_path(trans_id)), entry
2193
def _iter_entries_for_dir(self, dir_path):
2194
"""Return path, entry for items in a directory without recursing down."""
2195
dir_file_id = self.path2id(dir_path)
2197
for file_id in self.iter_children(dir_file_id):
2198
trans_id = self._transform.trans_id_file_id(file_id)
2199
ordered_ids.append((trans_id, file_id))
2200
for entry, trans_id in self._make_inv_entries(ordered_ids):
2201
yield unicode(self._final_paths.get_path(trans_id)), entry
2203
def list_files(self, include_root=False, from_dir=None, recursive=True):
2204
"""See WorkingTree.list_files."""
2205
# XXX This should behave like WorkingTree.list_files, but is really
2206
# more like RevisionTree.list_files.
2210
prefix = from_dir + '/'
2211
entries = self.iter_entries_by_dir()
2212
for path, entry in entries:
2213
if entry.name == '' and not include_root:
2216
if not path.startswith(prefix):
2218
path = path[len(prefix):]
2219
yield path, 'V', entry.kind, entry.file_id, entry
2221
if from_dir is None and include_root is True:
2222
root_entry = inventory.make_entry('directory', '',
2223
ROOT_PARENT, self.get_root_id())
2224
yield '', 'V', 'directory', root_entry.file_id, root_entry
2225
entries = self._iter_entries_for_dir(from_dir or '')
2226
for path, entry in entries:
2227
yield path, 'V', entry.kind, entry.file_id, entry
2229
def kind(self, file_id):
2230
trans_id = self._transform.trans_id_file_id(file_id)
2231
return self._transform.final_kind(trans_id)
2233
def stored_kind(self, file_id):
2234
trans_id = self._transform.trans_id_file_id(file_id)
2236
return self._transform._new_contents[trans_id]
2238
return self._transform._tree.stored_kind(file_id)
2240
def get_file_mtime(self, file_id, path=None):
2241
"""See Tree.get_file_mtime"""
2242
if not self._content_change(file_id):
2243
return self._transform._tree.get_file_mtime(file_id)
2244
return self._stat_limbo_file(file_id).st_mtime
2246
def _file_size(self, entry, stat_value):
2247
return self.get_file_size(entry.file_id)
2249
def get_file_size(self, file_id):
2250
"""See Tree.get_file_size"""
2251
trans_id = self._transform.trans_id_file_id(file_id)
2252
kind = self._transform.final_kind(trans_id)
2255
if trans_id in self._transform._new_contents:
2256
return self._stat_limbo_file(trans_id=trans_id).st_size
2257
if self.kind(file_id) == 'file':
2258
return self._transform._tree.get_file_size(file_id)
2262
def get_file_verifier(self, file_id, path=None, stat_value=None):
2263
trans_id = self._transform.trans_id_file_id(file_id)
2264
kind = self._transform._new_contents.get(trans_id)
2266
return self._transform._tree.get_file_verifier(file_id)
2268
fileobj = self.get_file(file_id)
2270
return ("SHA1", sha_file(fileobj))
2274
def get_file_sha1(self, file_id, path=None, stat_value=None):
2275
trans_id = self._transform.trans_id_file_id(file_id)
2276
kind = self._transform._new_contents.get(trans_id)
2278
return self._transform._tree.get_file_sha1(file_id)
2280
fileobj = self.get_file(file_id)
2282
return sha_file(fileobj)
2286
def is_executable(self, file_id, path=None):
2289
trans_id = self._transform.trans_id_file_id(file_id)
2291
return self._transform._new_executability[trans_id]
2294
return self._transform._tree.is_executable(file_id, path)
2296
if e.errno == errno.ENOENT:
2299
except errors.NoSuchId:
2302
def has_filename(self, path):
2303
trans_id = self._path2trans_id(path)
2304
if trans_id in self._transform._new_contents:
2306
elif trans_id in self._transform._removed_contents:
2309
return self._transform._tree.has_filename(path)
2311
def path_content_summary(self, path):
2312
trans_id = self._path2trans_id(path)
2313
tt = self._transform
2314
tree_path = tt._tree_id_paths.get(trans_id)
2315
kind = tt._new_contents.get(trans_id)
2317
if tree_path is None or trans_id in tt._removed_contents:
2318
return 'missing', None, None, None
2319
summary = tt._tree.path_content_summary(tree_path)
2320
kind, size, executable, link_or_sha1 = summary
2323
limbo_name = tt._limbo_name(trans_id)
2324
if trans_id in tt._new_reference_revision:
2325
kind = 'tree-reference'
2327
statval = os.lstat(limbo_name)
2328
size = statval.st_size
2329
if not supports_executable():
2332
executable = statval.st_mode & S_IEXEC
2336
if kind == 'symlink':
2337
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2338
executable = tt._new_executability.get(trans_id, executable)
2339
return kind, size, executable, link_or_sha1
2341
def iter_changes(self, from_tree, include_unchanged=False,
2342
specific_files=None, pb=None, extra_trees=None,
2343
require_versioned=True, want_unversioned=False):
2344
"""See InterTree.iter_changes.
2346
This has a fast path that is only used when the from_tree matches
2347
the transform tree, and no fancy options are supplied.
2349
if (from_tree is not self._transform._tree or include_unchanged or
2350
specific_files or want_unversioned):
2351
return tree.InterTree(from_tree, self).iter_changes(
2352
include_unchanged=include_unchanged,
2353
specific_files=specific_files,
2355
extra_trees=extra_trees,
2356
require_versioned=require_versioned,
2357
want_unversioned=want_unversioned)
2358
if want_unversioned:
2359
raise ValueError('want_unversioned is not supported')
2360
return self._transform.iter_changes()
2362
def get_file(self, file_id, path=None):
2363
"""See Tree.get_file"""
2364
if not self._content_change(file_id):
2365
return self._transform._tree.get_file(file_id, path)
2366
trans_id = self._transform.trans_id_file_id(file_id)
2367
name = self._transform._limbo_name(trans_id)
2368
return open(name, 'rb')
2370
def get_file_with_stat(self, file_id, path=None):
2371
return self.get_file(file_id, path), None
2373
def annotate_iter(self, file_id,
2374
default_revision=_mod_revision.CURRENT_REVISION):
2375
changes = self._iter_changes_cache.get(file_id)
2379
changed_content, versioned, kind = (changes[2], changes[3],
2383
get_old = (kind[0] == 'file' and versioned[0])
2385
old_annotation = self._transform._tree.annotate_iter(file_id,
2386
default_revision=default_revision)
2390
return old_annotation
2391
if not changed_content:
2392
return old_annotation
2393
# TODO: This is doing something similar to what WT.annotate_iter is
2394
# doing, however it fails slightly because it doesn't know what
2395
# the *other* revision_id is, so it doesn't know how to give the
2396
# other as the origin for some lines, they all get
2397
# 'default_revision'
2398
# It would be nice to be able to use the new Annotator based
2399
# approach, as well.
2400
return annotate.reannotate([old_annotation],
2401
self.get_file(file_id).readlines(),
2404
def get_symlink_target(self, file_id, path=None):
2405
"""See Tree.get_symlink_target"""
2406
if not self._content_change(file_id):
2407
return self._transform._tree.get_symlink_target(file_id)
2408
trans_id = self._transform.trans_id_file_id(file_id)
2409
name = self._transform._limbo_name(trans_id)
2410
return osutils.readlink(name)
2412
def walkdirs(self, prefix=''):
2413
pending = [self._transform.root]
2414
while len(pending) > 0:
2415
parent_id = pending.pop()
2418
prefix = prefix.rstrip('/')
2419
parent_path = self._final_paths.get_path(parent_id)
2420
parent_file_id = self._transform.final_file_id(parent_id)
2421
for child_id in self._all_children(parent_id):
2422
path_from_root = self._final_paths.get_path(child_id)
2423
basename = self._transform.final_name(child_id)
2424
file_id = self._transform.final_file_id(child_id)
2425
kind = self._transform.final_kind(child_id)
2426
if kind is not None:
2427
versioned_kind = kind
2430
versioned_kind = self._transform._tree.stored_kind(file_id)
2431
if versioned_kind == 'directory':
2432
subdirs.append(child_id)
2433
children.append((path_from_root, basename, kind, None,
2434
file_id, versioned_kind))
2436
if parent_path.startswith(prefix):
2437
yield (parent_path, parent_file_id), children
2438
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2441
def get_parent_ids(self):
2442
return self._parent_ids
2444
def set_parent_ids(self, parent_ids):
2445
self._parent_ids = parent_ids
2447
def get_revision_tree(self, revision_id):
2448
return self._transform._tree.get_revision_tree(revision_id)
2451
def joinpath(parent, child):
2452
"""Join tree-relative paths, handling the tree root specially"""
2453
if parent is None or parent == "":
2456
return pathjoin(parent, child)
2459
class FinalPaths(object):
2460
"""Make path calculation cheap by memoizing paths.
2462
The underlying tree must not be manipulated between calls, or else
2463
the results will likely be incorrect.
2465
def __init__(self, transform):
2466
object.__init__(self)
2467
self._known_paths = {}
2468
self.transform = transform
2470
def _determine_path(self, trans_id):
2471
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2473
name = self.transform.final_name(trans_id)
2474
parent_id = self.transform.final_parent(trans_id)
2475
if parent_id == self.transform.root:
2478
return pathjoin(self.get_path(parent_id), name)
2480
def get_path(self, trans_id):
2481
"""Find the final path associated with a trans_id"""
2482
if trans_id not in self._known_paths:
2483
self._known_paths[trans_id] = self._determine_path(trans_id)
2484
return self._known_paths[trans_id]
2486
def get_paths(self, trans_ids):
2487
return [(self.get_path(t), t) for t in trans_ids]
2491
def topology_sorted_ids(tree):
2492
"""Determine the topological order of the ids in a tree"""
2493
file_ids = list(tree)
2494
file_ids.sort(key=tree.id2path)
2498
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2499
delta_from_tree=False):
2500
"""Create working tree for a branch, using a TreeTransform.
2502
This function should be used on empty trees, having a tree root at most.
2503
(see merge and revert functionality for working with existing trees)
2505
Existing files are handled like so:
2507
- Existing bzrdirs take precedence over creating new items. They are
2508
created as '%s.diverted' % name.
2509
- Otherwise, if the content on disk matches the content we are building,
2510
it is silently replaced.
2511
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2513
:param tree: The tree to convert wt into a copy of
2514
:param wt: The working tree that files will be placed into
2515
:param accelerator_tree: A tree which can be used for retrieving file
2516
contents more quickly than tree itself, i.e. a workingtree. tree
2517
will be used for cases where accelerator_tree's content is different.
2518
:param hardlink: If true, hard-link files to accelerator_tree, where
2519
possible. accelerator_tree must implement abspath, i.e. be a
2521
:param delta_from_tree: If true, build_tree may use the input Tree to
2522
generate the inventory delta.
2524
wt.lock_tree_write()
2528
if accelerator_tree is not None:
2529
accelerator_tree.lock_read()
2531
return _build_tree(tree, wt, accelerator_tree, hardlink,
2534
if accelerator_tree is not None:
2535
accelerator_tree.unlock()
2542
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2543
"""See build_tree."""
2544
for num, _unused in enumerate(wt.all_file_ids()):
2545
if num > 0: # more than just a root
2546
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2548
top_pb = ui.ui_factory.nested_progress_bar()
2549
pp = ProgressPhase("Build phase", 2, top_pb)
2550
if tree.inventory.root is not None:
2551
# This is kind of a hack: we should be altering the root
2552
# as part of the regular tree shape diff logic.
2553
# The conditional test here is to avoid doing an
2554
# expensive operation (flush) every time the root id
2555
# is set within the tree, nor setting the root and thus
2556
# marking the tree as dirty, because we use two different
2557
# idioms here: tree interfaces and inventory interfaces.
2558
if wt.get_root_id() != tree.get_root_id():
2559
wt.set_root_id(tree.get_root_id())
2561
tt = TreeTransform(wt)
2565
file_trans_id[wt.get_root_id()] = \
2566
tt.trans_id_tree_file_id(wt.get_root_id())
2567
pb = ui.ui_factory.nested_progress_bar()
2569
deferred_contents = []
2571
total = len(tree.inventory)
2573
precomputed_delta = []
2575
precomputed_delta = None
2576
# Check if tree inventory has content. If so, we populate
2577
# existing_files with the directory content. If there are no
2578
# entries we skip populating existing_files as its not used.
2579
# This improves performance and unncessary work on large
2580
# directory trees. (#501307)
2582
existing_files = set()
2583
for dir, files in wt.walkdirs():
2584
existing_files.update(f[0] for f in files)
2585
for num, (tree_path, entry) in \
2586
enumerate(tree.inventory.iter_entries_by_dir()):
2587
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2588
if entry.parent_id is None:
2591
file_id = entry.file_id
2593
precomputed_delta.append((None, tree_path, file_id, entry))
2594
if tree_path in existing_files:
2595
target_path = wt.abspath(tree_path)
2596
kind = file_kind(target_path)
2597
if kind == "directory":
2599
bzrdir.BzrDir.open(target_path)
2600
except errors.NotBranchError:
2604
if (file_id not in divert and
2605
_content_match(tree, entry, file_id, kind,
2607
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2608
if kind == 'directory':
2610
parent_id = file_trans_id[entry.parent_id]
2611
if entry.kind == 'file':
2612
# We *almost* replicate new_by_entry, so that we can defer
2613
# getting the file text, and get them all at once.
2614
trans_id = tt.create_path(entry.name, parent_id)
2615
file_trans_id[file_id] = trans_id
2616
tt.version_file(file_id, trans_id)
2617
executable = tree.is_executable(file_id, tree_path)
2619
tt.set_executability(executable, trans_id)
2620
trans_data = (trans_id, tree_path, entry.text_sha1)
2621
deferred_contents.append((file_id, trans_data))
2623
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2626
new_trans_id = file_trans_id[file_id]
2627
old_parent = tt.trans_id_tree_path(tree_path)
2628
_reparent_children(tt, old_parent, new_trans_id)
2629
offset = num + 1 - len(deferred_contents)
2630
_create_files(tt, tree, deferred_contents, pb, offset,
2631
accelerator_tree, hardlink)
2635
divert_trans = set(file_trans_id[f] for f in divert)
2636
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2637
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2638
if len(raw_conflicts) > 0:
2639
precomputed_delta = None
2640
conflicts = cook_conflicts(raw_conflicts, tt)
2641
for conflict in conflicts:
2642
trace.warning(unicode(conflict))
2644
wt.add_conflicts(conflicts)
2645
except errors.UnsupportedOperation:
2647
result = tt.apply(no_conflicts=True,
2648
precomputed_delta=precomputed_delta)
2655
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2657
total = len(desired_files) + offset
2659
if accelerator_tree is None:
2660
new_desired_files = desired_files
2662
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2663
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2664
in iter if not (c or e[0] != e[1])]
2665
if accelerator_tree.supports_content_filtering():
2666
unchanged = [(f, p) for (f, p) in unchanged
2667
if not accelerator_tree.iter_search_rules([p]).next()]
2668
unchanged = dict(unchanged)
2669
new_desired_files = []
2671
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2672
accelerator_path = unchanged.get(file_id)
2673
if accelerator_path is None:
2674
new_desired_files.append((file_id,
2675
(trans_id, tree_path, text_sha1)))
2677
pb.update(gettext('Adding file contents'), count + offset, total)
2679
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2682
contents = accelerator_tree.get_file(file_id, accelerator_path)
2683
if wt.supports_content_filtering():
2684
filters = wt._content_filter_stack(tree_path)
2685
contents = filtered_output_bytes(contents, filters,
2686
ContentFilterContext(tree_path, tree))
2688
tt.create_file(contents, trans_id, sha1=text_sha1)
2692
except AttributeError:
2693
# after filtering, contents may no longer be file-like
2697
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2698
tree.iter_files_bytes(new_desired_files)):
2699
if wt.supports_content_filtering():
2700
filters = wt._content_filter_stack(tree_path)
2701
contents = filtered_output_bytes(contents, filters,
2702
ContentFilterContext(tree_path, tree))
2703
tt.create_file(contents, trans_id, sha1=text_sha1)
2704
pb.update(gettext('Adding file contents'), count + offset, total)
2707
def _reparent_children(tt, old_parent, new_parent):
2708
for child in tt.iter_tree_children(old_parent):
2709
tt.adjust_path(tt.final_name(child), new_parent, child)
2712
def _reparent_transform_children(tt, old_parent, new_parent):
2713
by_parent = tt.by_parent()
2714
for child in by_parent[old_parent]:
2715
tt.adjust_path(tt.final_name(child), new_parent, child)
2716
return by_parent[old_parent]
2719
def _content_match(tree, entry, file_id, kind, target_path):
2720
if entry.kind != kind:
2722
if entry.kind == "directory":
2724
if entry.kind == "file":
2725
f = file(target_path, 'rb')
2727
if tree.get_file_text(file_id) == f.read():
2731
elif entry.kind == "symlink":
2732
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2737
def resolve_checkout(tt, conflicts, divert):
2738
new_conflicts = set()
2739
for c_type, conflict in ((c[0], c) for c in conflicts):
2740
# Anything but a 'duplicate' would indicate programmer error
2741
if c_type != 'duplicate':
2742
raise AssertionError(c_type)
2743
# Now figure out which is new and which is old
2744
if tt.new_contents(conflict[1]):
2745
new_file = conflict[1]
2746
old_file = conflict[2]
2748
new_file = conflict[2]
2749
old_file = conflict[1]
2751
# We should only get here if the conflict wasn't completely
2753
final_parent = tt.final_parent(old_file)
2754
if new_file in divert:
2755
new_name = tt.final_name(old_file)+'.diverted'
2756
tt.adjust_path(new_name, final_parent, new_file)
2757
new_conflicts.add((c_type, 'Diverted to',
2758
new_file, old_file))
2760
new_name = tt.final_name(old_file)+'.moved'
2761
tt.adjust_path(new_name, final_parent, old_file)
2762
new_conflicts.add((c_type, 'Moved existing file to',
2763
old_file, new_file))
2764
return new_conflicts
2767
def new_by_entry(tt, entry, parent_id, tree):
2768
"""Create a new file according to its inventory entry"""
2772
contents = tree.get_file(entry.file_id).readlines()
2773
executable = tree.is_executable(entry.file_id)
2774
return tt.new_file(name, parent_id, contents, entry.file_id,
2776
elif kind in ('directory', 'tree-reference'):
2777
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2778
if kind == 'tree-reference':
2779
tt.set_tree_reference(entry.reference_revision, trans_id)
2781
elif kind == 'symlink':
2782
target = tree.get_symlink_target(entry.file_id)
2783
return tt.new_symlink(name, parent_id, target, entry.file_id)
2785
raise errors.BadFileKindError(name, kind)
2788
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2789
filter_tree_path=None):
2790
"""Create new file contents according to tree contents.
2792
:param filter_tree_path: the tree path to use to lookup
2793
content filters to apply to the bytes output in the working tree.
2794
This only applies if the working tree supports content filtering.
2796
kind = tree.kind(file_id)
2797
if kind == 'directory':
2798
tt.create_directory(trans_id)
2799
elif kind == "file":
2801
tree_file = tree.get_file(file_id)
2803
bytes = tree_file.readlines()
2807
if wt.supports_content_filtering() and filter_tree_path is not None:
2808
filters = wt._content_filter_stack(filter_tree_path)
2809
bytes = filtered_output_bytes(bytes, filters,
2810
ContentFilterContext(filter_tree_path, tree))
2811
tt.create_file(bytes, trans_id)
2812
elif kind == "symlink":
2813
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2815
raise AssertionError('Unknown kind %r' % kind)
2818
def create_entry_executability(tt, entry, trans_id):
2819
"""Set the executability of a trans_id according to an inventory entry"""
2820
if entry.kind == "file":
2821
tt.set_executability(entry.executable, trans_id)
2824
@deprecated_function(deprecated_in((2, 3, 0)))
2825
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2826
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2829
@deprecated_function(deprecated_in((2, 3, 0)))
2830
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2831
"""Produce a backup-style name that appears to be available"""
2835
yield "%s.~%d~" % (name, counter)
2837
for new_name in name_gen():
2838
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2842
def _entry_changes(file_id, entry, working_tree):
2843
"""Determine in which ways the inventory entry has changed.
2845
Returns booleans: has_contents, content_mod, meta_mod
2846
has_contents means there are currently contents, but they differ
2847
contents_mod means contents need to be modified
2848
meta_mod means the metadata needs to be modified
2850
cur_entry = working_tree.inventory[file_id]
2852
working_kind = working_tree.kind(file_id)
2855
has_contents = False
2858
if has_contents is True:
2859
if entry.kind != working_kind:
2860
contents_mod, meta_mod = True, False
2862
cur_entry._read_tree_state(working_tree.id2path(file_id),
2864
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2865
cur_entry._forget_tree_state()
2866
return has_contents, contents_mod, meta_mod
2869
def revert(working_tree, target_tree, filenames, backups=False,
2870
pb=None, change_reporter=None):
2871
"""Revert a working tree's contents to those of a target tree."""
2872
target_tree.lock_read()
2873
pb = ui.ui_factory.nested_progress_bar()
2874
tt = TreeTransform(working_tree, pb)
2876
pp = ProgressPhase("Revert phase", 3, pb)
2877
conflicts, merge_modified = _prepare_revert_transform(
2878
working_tree, target_tree, tt, filenames, backups, pp)
2880
change_reporter = delta._ChangeReporter(
2881
unversioned_filter=working_tree.is_ignored)
2882
delta.report_changes(tt.iter_changes(), change_reporter)
2883
for conflict in conflicts:
2884
trace.warning(unicode(conflict))
2887
working_tree.set_merge_modified(merge_modified)
2889
target_tree.unlock()
2895
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2896
backups, pp, basis_tree=None,
2897
merge_modified=None):
2898
child_pb = ui.ui_factory.nested_progress_bar()
2900
if merge_modified is None:
2901
merge_modified = working_tree.merge_modified()
2902
merge_modified = _alter_files(working_tree, target_tree, tt,
2903
child_pb, filenames, backups,
2904
merge_modified, basis_tree)
2907
child_pb = ui.ui_factory.nested_progress_bar()
2909
raw_conflicts = resolve_conflicts(tt, child_pb,
2910
lambda t, c: conflict_pass(t, c, target_tree))
2913
conflicts = cook_conflicts(raw_conflicts, tt)
2914
return conflicts, merge_modified
2917
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2918
backups, merge_modified, basis_tree=None):
2919
if basis_tree is not None:
2920
basis_tree.lock_read()
2921
# We ask the working_tree for its changes relative to the target, rather
2922
# than the target changes relative to the working tree. Because WT4 has an
2923
# optimizer to compare itself to a target, but no optimizer for the
2925
change_list = working_tree.iter_changes(target_tree,
2926
specific_files=specific_files, pb=pb)
2927
if target_tree.get_root_id() is None:
2933
for id_num, (file_id, path, changed_content, versioned, parent, name,
2934
kind, executable) in enumerate(change_list):
2935
target_path, wt_path = path
2936
target_versioned, wt_versioned = versioned
2937
target_parent, wt_parent = parent
2938
target_name, wt_name = name
2939
target_kind, wt_kind = kind
2940
target_executable, wt_executable = executable
2941
if skip_root and wt_parent is None:
2943
trans_id = tt.trans_id_file_id(file_id)
2946
keep_content = False
2947
if wt_kind == 'file' and (backups or target_kind is None):
2948
wt_sha1 = working_tree.get_file_sha1(file_id)
2949
if merge_modified.get(file_id) != wt_sha1:
2950
# acquire the basis tree lazily to prevent the
2951
# expense of accessing it when it's not needed ?
2952
# (Guessing, RBC, 200702)
2953
if basis_tree is None:
2954
basis_tree = working_tree.basis_tree()
2955
basis_tree.lock_read()
2956
if basis_tree.has_id(file_id):
2957
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2959
elif target_kind is None and not target_versioned:
2961
if wt_kind is not None:
2962
if not keep_content:
2963
tt.delete_contents(trans_id)
2964
elif target_kind is not None:
2965
parent_trans_id = tt.trans_id_file_id(wt_parent)
2966
backup_name = tt._available_backup_name(
2967
wt_name, parent_trans_id)
2968
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2969
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2970
if wt_versioned and target_versioned:
2971
tt.unversion_file(trans_id)
2972
tt.version_file(file_id, new_trans_id)
2973
# New contents should have the same unix perms as old
2976
trans_id = new_trans_id
2977
if target_kind in ('directory', 'tree-reference'):
2978
tt.create_directory(trans_id)
2979
if target_kind == 'tree-reference':
2980
revision = target_tree.get_reference_revision(file_id,
2982
tt.set_tree_reference(revision, trans_id)
2983
elif target_kind == 'symlink':
2984
tt.create_symlink(target_tree.get_symlink_target(file_id),
2986
elif target_kind == 'file':
2987
deferred_files.append((file_id, (trans_id, mode_id)))
2988
if basis_tree is None:
2989
basis_tree = working_tree.basis_tree()
2990
basis_tree.lock_read()
2991
new_sha1 = target_tree.get_file_sha1(file_id)
2992
if (basis_tree.has_id(file_id) and
2993
new_sha1 == basis_tree.get_file_sha1(file_id)):
2994
if file_id in merge_modified:
2995
del merge_modified[file_id]
2997
merge_modified[file_id] = new_sha1
2999
# preserve the execute bit when backing up
3000
if keep_content and wt_executable == target_executable:
3001
tt.set_executability(target_executable, trans_id)
3002
elif target_kind is not None:
3003
raise AssertionError(target_kind)
3004
if not wt_versioned and target_versioned:
3005
tt.version_file(file_id, trans_id)
3006
if wt_versioned and not target_versioned:
3007
tt.unversion_file(trans_id)
3008
if (target_name is not None and
3009
(wt_name != target_name or wt_parent != target_parent)):
3010
if target_name == '' and target_parent is None:
3011
parent_trans = ROOT_PARENT
3013
parent_trans = tt.trans_id_file_id(target_parent)
3014
if wt_parent is None and wt_versioned:
3015
tt.adjust_root_path(target_name, parent_trans)
3017
tt.adjust_path(target_name, parent_trans, trans_id)
3018
if wt_executable != target_executable and target_kind == "file":
3019
tt.set_executability(target_executable, trans_id)
3020
if working_tree.supports_content_filtering():
3021
for index, ((trans_id, mode_id), bytes) in enumerate(
3022
target_tree.iter_files_bytes(deferred_files)):
3023
file_id = deferred_files[index][0]
3024
# We're reverting a tree to the target tree so using the
3025
# target tree to find the file path seems the best choice
3026
# here IMO - Ian C 27/Oct/2009
3027
filter_tree_path = target_tree.id2path(file_id)
3028
filters = working_tree._content_filter_stack(filter_tree_path)
3029
bytes = filtered_output_bytes(bytes, filters,
3030
ContentFilterContext(filter_tree_path, working_tree))
3031
tt.create_file(bytes, trans_id, mode_id)
3033
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3035
tt.create_file(bytes, trans_id, mode_id)
3036
tt.fixup_new_roots()
3038
if basis_tree is not None:
3040
return merge_modified
3043
def resolve_conflicts(tt, pb=None, pass_func=None):
3044
"""Make many conflict-resolution attempts, but die if they fail"""
3045
if pass_func is None:
3046
pass_func = conflict_pass
3047
new_conflicts = set()
3048
pb = ui.ui_factory.nested_progress_bar()
3051
pb.update(gettext('Resolution pass'), n+1, 10)
3052
conflicts = tt.find_conflicts()
3053
if len(conflicts) == 0:
3054
return new_conflicts
3055
new_conflicts.update(pass_func(tt, conflicts))
3056
raise MalformedTransform(conflicts=conflicts)
3061
def conflict_pass(tt, conflicts, path_tree=None):
3062
"""Resolve some classes of conflicts.
3064
:param tt: The transform to resolve conflicts in
3065
:param conflicts: The conflicts to resolve
3066
:param path_tree: A Tree to get supplemental paths from
3068
new_conflicts = set()
3069
for c_type, conflict in ((c[0], c) for c in conflicts):
3070
if c_type == 'duplicate id':
3071
tt.unversion_file(conflict[1])
3072
new_conflicts.add((c_type, 'Unversioned existing file',
3073
conflict[1], conflict[2], ))
3074
elif c_type == 'duplicate':
3075
# files that were renamed take precedence
3076
final_parent = tt.final_parent(conflict[1])
3077
if tt.path_changed(conflict[1]):
3078
existing_file, new_file = conflict[2], conflict[1]
3080
existing_file, new_file = conflict[1], conflict[2]
3081
new_name = tt.final_name(existing_file)+'.moved'
3082
tt.adjust_path(new_name, final_parent, existing_file)
3083
new_conflicts.add((c_type, 'Moved existing file to',
3084
existing_file, new_file))
3085
elif c_type == 'parent loop':
3086
# break the loop by undoing one of the ops that caused the loop
3088
while not tt.path_changed(cur):
3089
cur = tt.final_parent(cur)
3090
new_conflicts.add((c_type, 'Cancelled move', cur,
3091
tt.final_parent(cur),))
3092
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3094
elif c_type == 'missing parent':
3095
trans_id = conflict[1]
3096
if trans_id in tt._removed_contents:
3097
cancel_deletion = True
3098
orphans = tt._get_potential_orphans(trans_id)
3100
cancel_deletion = False
3101
# All children are orphans
3104
tt.new_orphan(o, trans_id)
3105
except OrphaningError:
3106
# Something bad happened so we cancel the directory
3107
# deletion which will leave it in place with a
3108
# conflict. The user can deal with it from there.
3109
# Note that this also catch the case where we don't
3110
# want to create orphans and leave the directory in
3112
cancel_deletion = True
3115
# Cancel the directory deletion
3116
tt.cancel_deletion(trans_id)
3117
new_conflicts.add(('deleting parent', 'Not deleting',
3122
tt.final_name(trans_id)
3124
if path_tree is not None:
3125
file_id = tt.final_file_id(trans_id)
3127
file_id = tt.inactive_file_id(trans_id)
3128
_, entry = path_tree.iter_entries_by_dir(
3130
# special-case the other tree root (move its
3131
# children to current root)
3132
if entry.parent_id is None:
3134
moved = _reparent_transform_children(
3135
tt, trans_id, tt.root)
3137
new_conflicts.add((c_type, 'Moved to root',
3140
parent_trans_id = tt.trans_id_file_id(
3142
tt.adjust_path(entry.name, parent_trans_id,
3145
tt.create_directory(trans_id)
3146
new_conflicts.add((c_type, 'Created directory', trans_id))
3147
elif c_type == 'unversioned parent':
3148
file_id = tt.inactive_file_id(conflict[1])
3149
# special-case the other tree root (move its children instead)
3150
if path_tree and path_tree.has_id(file_id):
3151
if path_tree.path2id('') == file_id:
3152
# This is the root entry, skip it
3154
tt.version_file(file_id, conflict[1])
3155
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3156
elif c_type == 'non-directory parent':
3157
parent_id = conflict[1]
3158
parent_parent = tt.final_parent(parent_id)
3159
parent_name = tt.final_name(parent_id)
3160
parent_file_id = tt.final_file_id(parent_id)
3161
new_parent_id = tt.new_directory(parent_name + '.new',
3162
parent_parent, parent_file_id)
3163
_reparent_transform_children(tt, parent_id, new_parent_id)
3164
if parent_file_id is not None:
3165
tt.unversion_file(parent_id)
3166
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3167
elif c_type == 'versioning no contents':
3168
tt.cancel_versioning(conflict[1])
3169
return new_conflicts
3172
def cook_conflicts(raw_conflicts, tt):
3173
"""Generate a list of cooked conflicts, sorted by file path"""
3174
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3175
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3178
def iter_cook_conflicts(raw_conflicts, tt):
3180
for conflict in raw_conflicts:
3181
c_type = conflict[0]
3182
action = conflict[1]
3183
modified_path = fp.get_path(conflict[2])
3184
modified_id = tt.final_file_id(conflict[2])
3185
if len(conflict) == 3:
3186
yield conflicts.Conflict.factory(
3187
c_type, action=action, path=modified_path, file_id=modified_id)
3190
conflicting_path = fp.get_path(conflict[3])
3191
conflicting_id = tt.final_file_id(conflict[3])
3192
yield conflicts.Conflict.factory(
3193
c_type, action=action, path=modified_path,
3194
file_id=modified_id,
3195
conflict_path=conflicting_path,
3196
conflict_file_id=conflicting_id)
3199
class _FileMover(object):
3200
"""Moves and deletes files for TreeTransform, tracking operations"""
3203
self.past_renames = []
3204
self.pending_deletions = []
3206
def rename(self, from_, to):
3207
"""Rename a file from one path to another."""
3209
os.rename(from_, to)
3211
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3212
raise errors.FileExists(to, str(e))
3213
# normal OSError doesn't include filenames so it's hard to see where
3214
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3215
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3216
self.past_renames.append((from_, to))
3218
def pre_delete(self, from_, to):
3219
"""Rename a file out of the way and mark it for deletion.
3221
Unlike os.unlink, this works equally well for files and directories.
3222
:param from_: The current file path
3223
:param to: A temporary path for the file
3225
self.rename(from_, to)
3226
self.pending_deletions.append(to)
3229
"""Reverse all renames that have been performed"""
3230
for from_, to in reversed(self.past_renames):
3232
os.rename(to, from_)
3234
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3235
# after rollback, don't reuse _FileMover
3237
pending_deletions = None
3239
def apply_deletions(self):
3240
"""Apply all marked deletions"""
3241
for path in self.pending_deletions:
3243
# after apply_deletions, don't reuse _FileMover
3245
pending_deletions = None
added
removed
bzrlib/transform.py
