1
# Copyright (C) 2006-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from stat import S_ISREG, S_IEXEC
25
config as _mod_config,
32
lazy_import.lazy_import(globals(), """
43
revision as _mod_revision,
47
from breezy.bzr import (
51
from breezy.i18n import gettext
53
from .errors import (DuplicateKey, MalformedTransform,
54
ReusingTransform, CantMoveRoot,
55
ImmortalLimbo, NoFinalPath)
56
from .filters import filtered_output_bytes, ContentFilterContext
57
from .mutabletree import MutableTree
58
from .osutils import (
66
from .progress import ProgressPhase
78
ROOT_PARENT = "root-parent"
81
def unique_add(map, key, value):
83
raise DuplicateKey(key=key)
87
class _TransformResults(object):
88
def __init__(self, modified_paths, rename_count):
90
self.modified_paths = modified_paths
91
self.rename_count = rename_count
94
class TreeTransformBase(object):
95
"""The base class for TreeTransform and its kin."""
97
def __init__(self, tree, pb=None, case_sensitive=True):
100
:param tree: The tree that will be transformed, but not necessarily
103
:param case_sensitive: If True, the target of the transform is
104
case sensitive, not just case preserving.
106
object.__init__(self)
109
# mapping of trans_id -> new basename
111
# mapping of trans_id -> new parent trans_id
112
self._new_parent = {}
113
# mapping of trans_id with new contents -> new file_kind
114
self._new_contents = {}
115
# mapping of trans_id => (sha1 of content, stat_value)
116
self._observed_sha1s = {}
117
# Set of trans_ids whose contents will be removed
118
self._removed_contents = set()
119
# Mapping of trans_id -> new execute-bit value
120
self._new_executability = {}
121
# Mapping of trans_id -> new tree-reference value
122
self._new_reference_revision = {}
123
# Mapping of trans_id -> new file_id
125
# Mapping of old file-id -> trans_id
126
self._non_present_ids = {}
127
# Mapping of new file_id -> trans_id
129
# Set of trans_ids that will be removed
130
self._removed_id = set()
131
# Mapping of path in old tree -> trans_id
132
self._tree_path_ids = {}
133
# Mapping trans_id -> path in old tree
134
self._tree_id_paths = {}
135
# The trans_id that will be used as the tree root
136
if tree.is_versioned(''):
137
self._new_root = self.trans_id_tree_path('')
139
self._new_root = None
140
# Indicator of whether the transform has been applied
144
# Whether the target is case sensitive
145
self._case_sensitive_target = case_sensitive
146
# A counter of how many files have been renamed
147
self.rename_count = 0
150
"""Support Context Manager API."""
153
def __exit__(self, exc_type, exc_val, exc_tb):
154
"""Support Context Manager API."""
158
"""Release the working tree lock, if held.
160
This is required if apply has not been invoked, but can be invoked
163
if self._tree is None:
165
for hook in MutableTree.hooks['post_transform']:
166
hook(self._tree, self)
170
def __get_root(self):
171
return self._new_root
173
root = property(__get_root)
175
def _assign_id(self):
176
"""Produce a new tranform id"""
177
new_id = "new-%s" % self._id_number
181
def create_path(self, name, parent):
182
"""Assign a transaction id to a new path"""
183
trans_id = self._assign_id()
184
unique_add(self._new_name, trans_id, name)
185
unique_add(self._new_parent, trans_id, parent)
188
def adjust_path(self, name, parent, trans_id):
189
"""Change the path that is assigned to a transaction id."""
191
raise ValueError("Parent trans-id may not be None")
192
if trans_id == self._new_root:
194
self._new_name[trans_id] = name
195
self._new_parent[trans_id] = parent
197
def adjust_root_path(self, name, parent):
198
"""Emulate moving the root by moving all children, instead.
200
We do this by undoing the association of root's transaction id with the
201
current tree. This allows us to create a new directory with that
202
transaction id. We unversion the root directory and version the
203
physically new directory, and hope someone versions the tree root
206
old_root = self._new_root
207
old_root_file_id = self.final_file_id(old_root)
208
# force moving all children of root
209
for child_id in self.iter_tree_children(old_root):
210
if child_id != parent:
211
self.adjust_path(self.final_name(child_id),
212
self.final_parent(child_id), child_id)
213
file_id = self.final_file_id(child_id)
214
if file_id is not None:
215
self.unversion_file(child_id)
216
self.version_file(file_id, child_id)
218
# the physical root needs a new transaction id
219
self._tree_path_ids.pop("")
220
self._tree_id_paths.pop(old_root)
221
self._new_root = self.trans_id_tree_path('')
222
if parent == old_root:
223
parent = self._new_root
224
self.adjust_path(name, parent, old_root)
225
self.create_directory(old_root)
226
self.version_file(old_root_file_id, old_root)
227
self.unversion_file(self._new_root)
229
def fixup_new_roots(self):
230
"""Reinterpret requests to change the root directory
232
Instead of creating a root directory, or moving an existing directory,
233
all the attributes and children of the new root are applied to the
234
existing root directory.
236
This means that the old root trans-id becomes obsolete, so it is
237
recommended only to invoke this after the root trans-id has become
241
new_roots = [k for k, v in viewitems(self._new_parent)
243
if len(new_roots) < 1:
245
if len(new_roots) != 1:
246
raise ValueError('A tree cannot have two roots!')
247
if self._new_root is None:
248
self._new_root = new_roots[0]
250
old_new_root = new_roots[0]
251
# unversion the new root's directory.
252
if self.final_kind(self._new_root) is None:
253
file_id = self.final_file_id(old_new_root)
255
file_id = self.final_file_id(self._new_root)
256
if old_new_root in self._new_id:
257
self.cancel_versioning(old_new_root)
259
self.unversion_file(old_new_root)
260
# if, at this stage, root still has an old file_id, zap it so we can
261
# stick a new one in.
262
if (self.tree_file_id(self._new_root) is not None
263
and self._new_root not in self._removed_id):
264
self.unversion_file(self._new_root)
265
if file_id is not None:
266
self.version_file(file_id, self._new_root)
268
# Now move children of new root into old root directory.
269
# Ensure all children are registered with the transaction, but don't
270
# use directly-- some tree children have new parents
271
list(self.iter_tree_children(old_new_root))
272
# Move all children of new root into old root directory.
273
for child in self.by_parent().get(old_new_root, []):
274
self.adjust_path(self.final_name(child), self._new_root, child)
276
# Ensure old_new_root has no directory.
277
if old_new_root in self._new_contents:
278
self.cancel_creation(old_new_root)
280
self.delete_contents(old_new_root)
282
# prevent deletion of root directory.
283
if self._new_root in self._removed_contents:
284
self.cancel_deletion(self._new_root)
286
# destroy path info for old_new_root.
287
del self._new_parent[old_new_root]
288
del self._new_name[old_new_root]
290
def trans_id_file_id(self, file_id):
291
"""Determine or set the transaction id associated with a file ID.
292
A new id is only created for file_ids that were never present. If
293
a transaction has been unversioned, it is deliberately still returned.
294
(this will likely lead to an unversioned parent conflict.)
297
raise ValueError('None is not a valid file id')
298
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
299
return self._r_new_id[file_id]
302
path = self._tree.id2path(file_id)
303
except errors.NoSuchId:
304
if file_id in self._non_present_ids:
305
return self._non_present_ids[file_id]
307
trans_id = self._assign_id()
308
self._non_present_ids[file_id] = trans_id
311
return self.trans_id_tree_path(path)
313
def trans_id_tree_path(self, path):
314
"""Determine (and maybe set) the transaction ID for a tree path."""
315
path = self.canonical_path(path)
316
if path not in self._tree_path_ids:
317
self._tree_path_ids[path] = self._assign_id()
318
self._tree_id_paths[self._tree_path_ids[path]] = path
319
return self._tree_path_ids[path]
321
def get_tree_parent(self, trans_id):
322
"""Determine id of the parent in the tree."""
323
path = self._tree_id_paths[trans_id]
326
return self.trans_id_tree_path(os.path.dirname(path))
328
def delete_contents(self, trans_id):
329
"""Schedule the contents of a path entry for deletion"""
330
kind = self.tree_kind(trans_id)
332
self._removed_contents.add(trans_id)
334
def cancel_deletion(self, trans_id):
335
"""Cancel a scheduled deletion"""
336
self._removed_contents.remove(trans_id)
338
def unversion_file(self, trans_id):
339
"""Schedule a path entry to become unversioned"""
340
self._removed_id.add(trans_id)
342
def delete_versioned(self, trans_id):
343
"""Delete and unversion a versioned file"""
344
self.delete_contents(trans_id)
345
self.unversion_file(trans_id)
347
def set_executability(self, executability, trans_id):
348
"""Schedule setting of the 'execute' bit
349
To unschedule, set to None
351
if executability is None:
352
del self._new_executability[trans_id]
354
unique_add(self._new_executability, trans_id, executability)
356
def set_tree_reference(self, revision_id, trans_id):
357
"""Set the reference associated with a directory"""
358
unique_add(self._new_reference_revision, trans_id, revision_id)
360
def version_file(self, file_id, trans_id):
361
"""Schedule a file to become versioned."""
364
unique_add(self._new_id, trans_id, file_id)
365
unique_add(self._r_new_id, file_id, trans_id)
367
def cancel_versioning(self, trans_id):
368
"""Undo a previous versioning of a file"""
369
file_id = self._new_id[trans_id]
370
del self._new_id[trans_id]
371
del self._r_new_id[file_id]
373
def new_paths(self, filesystem_only=False):
374
"""Determine the paths of all new and changed files.
376
:param filesystem_only: if True, only calculate values for files
377
that require renames or execute bit changes.
381
stale_ids = self._needs_rename.difference(self._new_name)
382
stale_ids.difference_update(self._new_parent)
383
stale_ids.difference_update(self._new_contents)
384
stale_ids.difference_update(self._new_id)
385
needs_rename = self._needs_rename.difference(stale_ids)
386
id_sets = (needs_rename, self._new_executability)
388
id_sets = (self._new_name, self._new_parent, self._new_contents,
389
self._new_id, self._new_executability)
390
for id_set in id_sets:
391
new_ids.update(id_set)
392
return sorted(FinalPaths(self).get_paths(new_ids))
394
def _inventory_altered(self):
395
"""Determine which trans_ids need new Inventory entries.
397
An new entry is needed when anything that would be reflected by an
398
inventory entry changes, including file name, file_id, parent file_id,
399
file kind, and the execute bit.
401
Some care is taken to return entries with real changes, not cases
402
where the value is deleted and then restored to its original value,
403
but some actually unchanged values may be returned.
405
:returns: A list of (path, trans_id) for all items requiring an
406
inventory change. Ordered by path.
409
# Find entries whose file_ids are new (or changed).
410
new_file_id = set(t for t in self._new_id
411
if self._new_id[t] != self.tree_file_id(t))
412
for id_set in [self._new_name, self._new_parent, new_file_id,
413
self._new_executability]:
414
changed_ids.update(id_set)
415
# removing implies a kind change
416
changed_kind = set(self._removed_contents)
418
changed_kind.intersection_update(self._new_contents)
419
# Ignore entries that are already known to have changed.
420
changed_kind.difference_update(changed_ids)
421
# to keep only the truly changed ones
422
changed_kind = (t for t in changed_kind
423
if self.tree_kind(t) != self.final_kind(t))
424
# all kind changes will alter the inventory
425
changed_ids.update(changed_kind)
426
# To find entries with changed parent_ids, find parents which existed,
427
# but changed file_id.
428
# Now add all their children to the set.
429
for parent_trans_id in new_file_id:
430
changed_ids.update(self.iter_tree_children(parent_trans_id))
431
return sorted(FinalPaths(self).get_paths(changed_ids))
433
def final_kind(self, trans_id):
434
"""Determine the final file kind, after any changes applied.
436
:return: None if the file does not exist/has no contents. (It is
437
conceivable that a path would be created without the corresponding
438
contents insertion command)
440
if trans_id in self._new_contents:
441
return self._new_contents[trans_id]
442
elif trans_id in self._removed_contents:
445
return self.tree_kind(trans_id)
447
def tree_path(self, trans_id):
448
"""Determine the tree path associated with the trans_id."""
449
return self._tree_id_paths.get(trans_id)
451
def tree_file_id(self, trans_id):
452
"""Determine the file id associated with the trans_id in the tree"""
453
path = self.tree_path(trans_id)
456
# the file is old; the old id is still valid
457
if self._new_root == trans_id:
458
return self._tree.path2id('')
459
return self._tree.path2id(path)
461
def final_file_id(self, trans_id):
462
"""Determine the file id after any changes are applied, or None.
464
None indicates that the file will not be versioned after changes are
468
return self._new_id[trans_id]
470
if trans_id in self._removed_id:
472
return self.tree_file_id(trans_id)
474
def inactive_file_id(self, trans_id):
475
"""Return the inactive file_id associated with a transaction id.
476
That is, the one in the tree or in non_present_ids.
477
The file_id may actually be active, too.
479
file_id = self.tree_file_id(trans_id)
480
if file_id is not None:
482
for key, value in viewitems(self._non_present_ids):
483
if value == trans_id:
486
def final_parent(self, trans_id):
487
"""Determine the parent file_id, after any changes are applied.
489
ROOT_PARENT is returned for the tree root.
492
return self._new_parent[trans_id]
494
return self.get_tree_parent(trans_id)
496
def final_name(self, trans_id):
497
"""Determine the final filename, after all changes are applied."""
499
return self._new_name[trans_id]
502
return os.path.basename(self._tree_id_paths[trans_id])
504
raise NoFinalPath(trans_id, self)
507
"""Return a map of parent: children for known parents.
509
Only new paths and parents of tree files with assigned ids are used.
512
items = list(viewitems(self._new_parent))
513
items.extend((t, self.final_parent(t))
514
for t in list(self._tree_id_paths))
515
for trans_id, parent_id in items:
516
if parent_id not in by_parent:
517
by_parent[parent_id] = set()
518
by_parent[parent_id].add(trans_id)
521
def path_changed(self, trans_id):
522
"""Return True if a trans_id's path has changed."""
523
return (trans_id in self._new_name) or (trans_id in self._new_parent)
525
def new_contents(self, trans_id):
526
return (trans_id in self._new_contents)
528
def find_conflicts(self):
529
"""Find any violations of inventory or filesystem invariants"""
530
if self._done is True:
531
raise ReusingTransform()
533
# ensure all children of all existent parents are known
534
# all children of non-existent parents are known, by definition.
535
self._add_tree_children()
536
by_parent = self.by_parent()
537
conflicts.extend(self._unversioned_parents(by_parent))
538
conflicts.extend(self._parent_loops())
539
conflicts.extend(self._duplicate_entries(by_parent))
540
conflicts.extend(self._duplicate_ids())
541
conflicts.extend(self._parent_type_conflicts(by_parent))
542
conflicts.extend(self._improper_versioning())
543
conflicts.extend(self._executability_conflicts())
544
conflicts.extend(self._overwrite_conflicts())
547
def _check_malformed(self):
548
conflicts = self.find_conflicts()
549
if len(conflicts) != 0:
550
raise MalformedTransform(conflicts=conflicts)
552
def _add_tree_children(self):
553
"""Add all the children of all active parents to the known paths.
555
Active parents are those which gain children, and those which are
556
removed. This is a necessary first step in detecting conflicts.
558
parents = list(self.by_parent())
559
parents.extend([t for t in self._removed_contents if
560
self.tree_kind(t) == 'directory'])
561
for trans_id in self._removed_id:
562
path = self.tree_path(trans_id)
564
if self._tree.stored_kind(path) == 'directory':
565
parents.append(trans_id)
566
elif self.tree_kind(trans_id) == 'directory':
567
parents.append(trans_id)
569
for parent_id in parents:
570
# ensure that all children are registered with the transaction
571
list(self.iter_tree_children(parent_id))
573
def _has_named_child(self, name, parent_id, known_children):
574
"""Does a parent already have a name child.
576
:param name: The searched for name.
578
:param parent_id: The parent for which the check is made.
580
:param known_children: The already known children. This should have
581
been recently obtained from `self.by_parent.get(parent_id)`
582
(or will be if None is passed).
584
if known_children is None:
585
known_children = self.by_parent().get(parent_id, [])
586
for child in known_children:
587
if self.final_name(child) == name:
589
parent_path = self._tree_id_paths.get(parent_id, None)
590
if parent_path is None:
591
# No parent... no children
593
child_path = joinpath(parent_path, name)
594
child_id = self._tree_path_ids.get(child_path, None)
596
# Not known by the tree transform yet, check the filesystem
597
return osutils.lexists(self._tree.abspath(child_path))
599
raise AssertionError('child_id is missing: %s, %s, %s'
600
% (name, parent_id, child_id))
602
def _available_backup_name(self, name, target_id):
603
"""Find an available backup name.
605
:param name: The basename of the file.
607
:param target_id: The directory trans_id where the backup should
610
known_children = self.by_parent().get(target_id, [])
611
return osutils.available_backup_name(
613
lambda base: self._has_named_child(
614
base, target_id, known_children))
616
def _parent_loops(self):
617
"""No entry should be its own ancestor"""
619
for trans_id in self._new_parent:
622
while parent_id != ROOT_PARENT:
625
parent_id = self.final_parent(parent_id)
628
if parent_id == trans_id:
629
conflicts.append(('parent loop', trans_id))
630
if parent_id in seen:
634
def _unversioned_parents(self, by_parent):
635
"""If parent directories are versioned, children must be versioned."""
637
for parent_id, children in viewitems(by_parent):
638
if parent_id == ROOT_PARENT:
640
if self.final_file_id(parent_id) is not None:
642
for child_id in children:
643
if self.final_file_id(child_id) is not None:
644
conflicts.append(('unversioned parent', parent_id))
648
def _improper_versioning(self):
649
"""Cannot version a file with no contents, or a bad type.
651
However, existing entries with no contents are okay.
654
for trans_id in self._new_id:
655
kind = self.final_kind(trans_id)
656
if kind == 'symlink' and not self._tree.supports_symlinks():
657
# Ignore symlinks as they are not supported on this platform
660
conflicts.append(('versioning no contents', trans_id))
662
if not self._tree.versionable_kind(kind):
663
conflicts.append(('versioning bad kind', trans_id, kind))
666
def _executability_conflicts(self):
667
"""Check for bad executability changes.
669
Only versioned files may have their executability set, because
670
1. only versioned entries can have executability under windows
671
2. only files can be executable. (The execute bit on a directory
672
does not indicate searchability)
675
for trans_id in self._new_executability:
676
if self.final_file_id(trans_id) is None:
677
conflicts.append(('unversioned executability', trans_id))
679
if self.final_kind(trans_id) != "file":
680
conflicts.append(('non-file executability', trans_id))
683
def _overwrite_conflicts(self):
684
"""Check for overwrites (not permitted on Win32)"""
686
for trans_id in self._new_contents:
687
if self.tree_kind(trans_id) is None:
689
if trans_id not in self._removed_contents:
690
conflicts.append(('overwrite', trans_id,
691
self.final_name(trans_id)))
694
def _duplicate_entries(self, by_parent):
695
"""No directory may have two entries with the same name."""
697
if (self._new_name, self._new_parent) == ({}, {}):
699
for children in viewvalues(by_parent):
701
for child_tid in children:
702
name = self.final_name(child_tid)
704
# Keep children only if they still exist in the end
705
if not self._case_sensitive_target:
707
name_ids.append((name, child_tid))
711
for name, trans_id in name_ids:
712
kind = self.final_kind(trans_id)
713
file_id = self.final_file_id(trans_id)
714
if kind is None and file_id is None:
716
if name == last_name:
717
conflicts.append(('duplicate', last_trans_id, trans_id,
720
last_trans_id = trans_id
723
def _duplicate_ids(self):
724
"""Each inventory id may only be used once"""
727
all_ids = self._tree.all_file_ids()
728
except errors.UnsupportedOperation:
729
# it's okay for non-file-id trees to raise UnsupportedOperation.
731
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
733
active_tree_ids = all_ids.difference(removed_tree_ids)
734
for trans_id, file_id in viewitems(self._new_id):
735
if file_id in active_tree_ids:
736
path = self._tree.id2path(file_id)
737
old_trans_id = self.trans_id_tree_path(path)
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 viewitems(by_parent):
745
if parent_id == 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 self._tree._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 | (0o100 & ~umask)
775
# Enable x-bit for others only if they can read it.
776
if current_mode & 0o004:
777
to_mode |= 0o001 & ~umask
778
if current_mode & 0o040:
779
to_mode |= 0o010 & ~umask
781
to_mode = current_mode & ~0o111
782
osutils.chmod_if_possible(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)
880
trans_ids.update(self._removed_contents)
881
trans_ids.update(self._new_contents)
882
trans_ids.update(self._new_executability)
883
trans_ids.update(self._new_name)
884
trans_ids.update(self._new_parent)
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, from_path):
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 = next(self._tree.iter_entries_by_dir(
912
specific_files=[from_path]))[1]
913
from_name = from_entry.name
914
from_parent = from_entry.parent_id
917
if from_path is None:
918
# File does not exist in FROM state
922
# File exists, but is not versioned. Have to use path-
924
from_name = os.path.basename(from_path)
925
tree_parent = self.get_tree_parent(from_trans_id)
926
from_parent = self.tree_file_id(tree_parent)
927
if from_path is not None:
928
from_kind, from_executable, from_stats = \
929
self._tree._comparison_data(from_entry, from_path)
932
from_executable = False
933
return from_name, from_parent, from_kind, from_executable
935
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
936
"""Get data about a file in the to (target) state
938
Return a (name, parent, kind, executable) tuple
940
to_name = self.final_name(to_trans_id)
941
to_kind = self.final_kind(to_trans_id)
942
to_parent = self.final_file_id(self.final_parent(to_trans_id))
943
if to_trans_id in self._new_executability:
944
to_executable = self._new_executability[to_trans_id]
945
elif to_trans_id == from_trans_id:
946
to_executable = from_executable
948
to_executable = False
949
return to_name, to_parent, to_kind, to_executable
951
def iter_changes(self):
952
"""Produce output in the same format as Tree.iter_changes.
954
Will produce nonsensical results if invoked while inventory/filesystem
955
conflicts (as reported by TreeTransform.find_conflicts()) are present.
957
This reads the Transform, but only reproduces changes involving a
958
file_id. Files that are not versioned in either of the FROM or TO
959
states are not reflected.
961
final_paths = FinalPaths(self)
962
from_trans_ids, to_trans_ids = self._get_file_id_maps()
964
# Now iterate through all active file_ids
965
for file_id in set(from_trans_ids).union(to_trans_ids):
967
from_trans_id = from_trans_ids.get(file_id)
968
# find file ids, and determine versioning state
969
if from_trans_id is None:
970
from_versioned = False
971
from_trans_id = to_trans_ids[file_id]
973
from_versioned = True
974
to_trans_id = to_trans_ids.get(file_id)
975
if to_trans_id is None:
977
to_trans_id = from_trans_id
981
if not from_versioned:
984
from_path = self._tree_id_paths.get(from_trans_id)
988
to_path = final_paths.get_path(to_trans_id)
990
from_name, from_parent, from_kind, from_executable = \
991
self._from_file_data(from_trans_id, from_versioned, from_path)
993
to_name, to_parent, to_kind, to_executable = \
994
self._to_file_data(to_trans_id, from_trans_id, from_executable)
996
if from_kind != to_kind:
998
elif to_kind in ('file', 'symlink') and (
999
to_trans_id != from_trans_id
1000
or to_trans_id in self._new_contents):
1002
if (not modified and from_versioned == to_versioned
1003
and from_parent == to_parent and from_name == to_name
1004
and from_executable == to_executable):
1008
file_id, (from_path, to_path), modified,
1009
(from_versioned, to_versioned),
1010
(from_parent, to_parent),
1011
(from_name, to_name),
1012
(from_kind, to_kind),
1013
(from_executable, to_executable)))
1016
return (c.path[0] or '', c.path[1] or '')
1017
return iter(sorted(results, key=path_key))
1019
def get_preview_tree(self):
1020
"""Return a tree representing the result of the transform.
1022
The tree is a snapshot, and altering the TreeTransform will invalidate
1025
return _PreviewTree(self)
1027
def commit(self, branch, message, merge_parents=None, strict=False,
1028
timestamp=None, timezone=None, committer=None, authors=None,
1029
revprops=None, revision_id=None):
1030
"""Commit the result of this TreeTransform to a branch.
1032
:param branch: The branch to commit to.
1033
:param message: The message to attach to the commit.
1034
:param merge_parents: Additional parent revision-ids specified by
1036
:param strict: If True, abort the commit if there are unversioned
1038
:param timestamp: if not None, seconds-since-epoch for the time and
1039
date. (May be a float.)
1040
:param timezone: Optional timezone for timestamp, as an offset in
1042
:param committer: Optional committer in email-id format.
1043
(e.g. "J Random Hacker <jrandom@example.com>")
1044
:param authors: Optional list of authors in email-id format.
1045
:param revprops: Optional dictionary of revision properties.
1046
:param revision_id: Optional revision id. (Specifying a revision-id
1047
may reduce performance for some non-native formats.)
1048
:return: The revision_id of the revision committed.
1050
self._check_malformed()
1052
unversioned = set(self._new_contents).difference(set(self._new_id))
1053
for trans_id in unversioned:
1054
if self.final_file_id(trans_id) is None:
1055
raise errors.StrictCommitFailed()
1057
revno, last_rev_id = branch.last_revision_info()
1058
if last_rev_id == _mod_revision.NULL_REVISION:
1059
if merge_parents is not None:
1060
raise ValueError('Cannot supply merge parents for first'
1064
parent_ids = [last_rev_id]
1065
if merge_parents is not None:
1066
parent_ids.extend(merge_parents)
1067
if self._tree.get_revision_id() != last_rev_id:
1068
raise ValueError('TreeTransform not based on branch basis: %s' %
1069
self._tree.get_revision_id().decode('utf-8'))
1070
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1071
builder = branch.get_commit_builder(parent_ids,
1072
timestamp=timestamp,
1074
committer=committer,
1076
revision_id=revision_id)
1077
preview = self.get_preview_tree()
1078
list(builder.record_iter_changes(preview, last_rev_id,
1079
self.iter_changes()))
1080
builder.finish_inventory()
1081
revision_id = builder.commit(message)
1082
branch.set_last_revision_info(revno + 1, revision_id)
1085
def _text_parent(self, trans_id):
1086
path = self.tree_path(trans_id)
1088
if path is None or self._tree.kind(path) != 'file':
1090
except errors.NoSuchFile:
1094
def _get_parents_texts(self, trans_id):
1095
"""Get texts for compression parents of this file."""
1096
path = self._text_parent(trans_id)
1099
return (self._tree.get_file_text(path),)
1101
def _get_parents_lines(self, trans_id):
1102
"""Get lines for compression parents of this file."""
1103
path = self._text_parent(trans_id)
1106
return (self._tree.get_file_lines(path),)
1108
def serialize(self, serializer):
1109
"""Serialize this TreeTransform.
1111
:param serializer: A Serialiser like pack.ContainerSerializer.
1113
new_name = {k.encode('utf-8'): v.encode('utf-8')
1114
for k, v in viewitems(self._new_name)}
1115
new_parent = {k.encode('utf-8'): v.encode('utf-8')
1116
for k, v in viewitems(self._new_parent)}
1117
new_id = {k.encode('utf-8'): v
1118
for k, v in viewitems(self._new_id)}
1119
new_executability = {k.encode('utf-8'): int(v)
1120
for k, v in viewitems(self._new_executability)}
1121
tree_path_ids = {k.encode('utf-8'): v.encode('utf-8')
1122
for k, v in viewitems(self._tree_path_ids)}
1123
non_present_ids = {k: v.encode('utf-8')
1124
for k, v in viewitems(self._non_present_ids)}
1125
removed_contents = [trans_id.encode('utf-8')
1126
for trans_id in self._removed_contents]
1127
removed_id = [trans_id.encode('utf-8')
1128
for trans_id in self._removed_id]
1130
b'_id_number': self._id_number,
1131
b'_new_name': new_name,
1132
b'_new_parent': new_parent,
1133
b'_new_executability': new_executability,
1135
b'_tree_path_ids': tree_path_ids,
1136
b'_removed_id': removed_id,
1137
b'_removed_contents': removed_contents,
1138
b'_non_present_ids': non_present_ids,
1140
yield serializer.bytes_record(bencode.bencode(attribs),
1142
for trans_id, kind in sorted(viewitems(self._new_contents)):
1144
with open(self._limbo_name(trans_id), 'rb') as cur_file:
1145
lines = cur_file.readlines()
1146
parents = self._get_parents_lines(trans_id)
1147
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1148
content = b''.join(mpdiff.to_patch())
1149
if kind == 'directory':
1151
if kind == 'symlink':
1152
content = self._read_symlink_target(trans_id)
1153
if not isinstance(content, bytes):
1154
content = content.encode('utf-8')
1155
yield serializer.bytes_record(
1156
content, ((trans_id.encode('utf-8'), kind.encode('ascii')),))
1158
def deserialize(self, records):
1159
"""Deserialize a stored TreeTransform.
1161
:param records: An iterable of (names, content) tuples, as per
1162
pack.ContainerPushParser.
1164
names, content = next(records)
1165
attribs = bencode.bdecode(content)
1166
self._id_number = attribs[b'_id_number']
1167
self._new_name = {k.decode('utf-8'): v.decode('utf-8')
1168
for k, v in viewitems(attribs[b'_new_name'])}
1169
self._new_parent = {k.decode('utf-8'): v.decode('utf-8')
1170
for k, v in viewitems(attribs[b'_new_parent'])}
1171
self._new_executability = {
1172
k.decode('utf-8'): bool(v)
1173
for k, v in viewitems(attribs[b'_new_executability'])}
1174
self._new_id = {k.decode('utf-8'): v
1175
for k, v in viewitems(attribs[b'_new_id'])}
1176
self._r_new_id = {v: k for k, v in viewitems(self._new_id)}
1177
self._tree_path_ids = {}
1178
self._tree_id_paths = {}
1179
for bytepath, trans_id in viewitems(attribs[b'_tree_path_ids']):
1180
path = bytepath.decode('utf-8')
1181
trans_id = trans_id.decode('utf-8')
1182
self._tree_path_ids[path] = trans_id
1183
self._tree_id_paths[trans_id] = path
1184
self._removed_id = {trans_id.decode('utf-8')
1185
for trans_id in attribs[b'_removed_id']}
1186
self._removed_contents = set(
1187
trans_id.decode('utf-8')
1188
for trans_id in attribs[b'_removed_contents'])
1189
self._non_present_ids = {
1190
k: v.decode('utf-8')
1191
for k, v in viewitems(attribs[b'_non_present_ids'])}
1192
for ((trans_id, kind),), content in records:
1193
trans_id = trans_id.decode('utf-8')
1194
kind = kind.decode('ascii')
1196
mpdiff = multiparent.MultiParent.from_patch(content)
1197
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1198
self.create_file(lines, trans_id)
1199
if kind == 'directory':
1200
self.create_directory(trans_id)
1201
if kind == 'symlink':
1202
self.create_symlink(content.decode('utf-8'), trans_id)
1204
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1205
"""Schedule creation of a new file.
1209
:param contents: an iterator of strings, all of which will be written
1210
to the target destination.
1211
:param trans_id: TreeTransform handle
1212
:param mode_id: If not None, force the mode of the target file to match
1213
the mode of the object referenced by mode_id.
1214
Otherwise, we will try to preserve mode bits of an existing file.
1215
:param sha1: If the sha1 of this content is already known, pass it in.
1216
We can use it to prevent future sha1 computations.
1218
raise NotImplementedError(self.create_file)
1220
def create_directory(self, trans_id):
1221
"""Schedule creation of a new directory.
1223
See also new_directory.
1225
raise NotImplementedError(self.create_directory)
1227
def create_symlink(self, target, trans_id):
1228
"""Schedule creation of a new symbolic link.
1230
target is a bytestring.
1231
See also new_symlink.
1233
raise NotImplementedError(self.create_symlink)
1235
def create_hardlink(self, path, trans_id):
1236
"""Schedule creation of a hard link"""
1237
raise NotImplementedError(self.create_hardlink)
1239
def cancel_creation(self, trans_id):
1240
"""Cancel the creation of new file contents."""
1241
raise NotImplementedError(self.cancel_creation)
1244
class DiskTreeTransform(TreeTransformBase):
1245
"""Tree transform storing its contents on disk."""
1247
def __init__(self, tree, limbodir, pb=None, case_sensitive=True):
1249
:param tree: The tree that will be transformed, but not necessarily
1251
:param limbodir: A directory where new files can be stored until
1252
they are installed in their proper places
1254
:param case_sensitive: If True, the target of the transform is
1255
case sensitive, not just case preserving.
1257
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1258
self._limbodir = limbodir
1259
self._deletiondir = None
1260
# A mapping of transform ids to their limbo filename
1261
self._limbo_files = {}
1262
self._possibly_stale_limbo_files = set()
1263
# A mapping of transform ids to a set of the transform ids of children
1264
# that their limbo directory has
1265
self._limbo_children = {}
1266
# Map transform ids to maps of child filename to child transform id
1267
self._limbo_children_names = {}
1268
# List of transform ids that need to be renamed from limbo into place
1269
self._needs_rename = set()
1270
self._creation_mtime = None
1271
self._create_symlinks = osutils.supports_symlinks(self._limbodir)
1274
"""Release the working tree lock, if held, clean up limbo dir.
1276
This is required if apply has not been invoked, but can be invoked
1279
if self._tree is None:
1282
limbo_paths = list(viewvalues(self._limbo_files))
1283
limbo_paths.extend(self._possibly_stale_limbo_files)
1284
limbo_paths.sort(reverse=True)
1285
for path in limbo_paths:
1288
except OSError as e:
1289
if e.errno != errno.ENOENT:
1291
# XXX: warn? perhaps we just got interrupted at an
1292
# inconvenient moment, but perhaps files are disappearing
1295
delete_any(self._limbodir)
1297
# We don't especially care *why* the dir is immortal.
1298
raise ImmortalLimbo(self._limbodir)
1300
if self._deletiondir is not None:
1301
delete_any(self._deletiondir)
1303
raise errors.ImmortalPendingDeletion(self._deletiondir)
1305
TreeTransformBase.finalize(self)
1307
def _limbo_supports_executable(self):
1308
"""Check if the limbo path supports the executable bit."""
1309
return osutils.supports_executable(self._limbodir)
1311
def _limbo_name(self, trans_id):
1312
"""Generate the limbo name of a file"""
1313
limbo_name = self._limbo_files.get(trans_id)
1314
if limbo_name is None:
1315
limbo_name = self._generate_limbo_path(trans_id)
1316
self._limbo_files[trans_id] = limbo_name
1319
def _generate_limbo_path(self, trans_id):
1320
"""Generate a limbo path using the trans_id as the relative path.
1322
This is suitable as a fallback, and when the transform should not be
1323
sensitive to the path encoding of the limbo directory.
1325
self._needs_rename.add(trans_id)
1326
return pathjoin(self._limbodir, trans_id)
1328
def adjust_path(self, name, parent, trans_id):
1329
previous_parent = self._new_parent.get(trans_id)
1330
previous_name = self._new_name.get(trans_id)
1331
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1332
if (trans_id in self._limbo_files
1333
and trans_id not in self._needs_rename):
1334
self._rename_in_limbo([trans_id])
1335
if previous_parent != parent:
1336
self._limbo_children[previous_parent].remove(trans_id)
1337
if previous_parent != parent or previous_name != name:
1338
del self._limbo_children_names[previous_parent][previous_name]
1340
def _rename_in_limbo(self, trans_ids):
1341
"""Fix limbo names so that the right final path is produced.
1343
This means we outsmarted ourselves-- we tried to avoid renaming
1344
these files later by creating them with their final names in their
1345
final parents. But now the previous name or parent is no longer
1346
suitable, so we have to rename them.
1348
Even for trans_ids that have no new contents, we must remove their
1349
entries from _limbo_files, because they are now stale.
1351
for trans_id in trans_ids:
1352
old_path = self._limbo_files[trans_id]
1353
self._possibly_stale_limbo_files.add(old_path)
1354
del self._limbo_files[trans_id]
1355
if trans_id not in self._new_contents:
1357
new_path = self._limbo_name(trans_id)
1358
os.rename(old_path, new_path)
1359
self._possibly_stale_limbo_files.remove(old_path)
1360
for descendant in self._limbo_descendants(trans_id):
1361
desc_path = self._limbo_files[descendant]
1362
desc_path = new_path + desc_path[len(old_path):]
1363
self._limbo_files[descendant] = desc_path
1365
def _limbo_descendants(self, trans_id):
1366
"""Return the set of trans_ids whose limbo paths descend from this."""
1367
descendants = set(self._limbo_children.get(trans_id, []))
1368
for descendant in list(descendants):
1369
descendants.update(self._limbo_descendants(descendant))
1372
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1373
"""Schedule creation of a new file.
1377
:param contents: an iterator of strings, all of which will be written
1378
to the target destination.
1379
:param trans_id: TreeTransform handle
1380
:param mode_id: If not None, force the mode of the target file to match
1381
the mode of the object referenced by mode_id.
1382
Otherwise, we will try to preserve mode bits of an existing file.
1383
:param sha1: If the sha1 of this content is already known, pass it in.
1384
We can use it to prevent future sha1 computations.
1386
name = self._limbo_name(trans_id)
1387
with open(name, 'wb') as f:
1388
unique_add(self._new_contents, trans_id, 'file')
1389
f.writelines(contents)
1390
self._set_mtime(name)
1391
self._set_mode(trans_id, mode_id, S_ISREG)
1392
# It is unfortunate we have to use lstat instead of fstat, but we just
1393
# used utime and chmod on the file, so we need the accurate final
1395
if sha1 is not None:
1396
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1398
def _read_symlink_target(self, trans_id):
1399
return os.readlink(self._limbo_name(trans_id))
1401
def _set_mtime(self, path):
1402
"""All files that are created get the same mtime.
1404
This time is set by the first object to be created.
1406
if self._creation_mtime is None:
1407
self._creation_mtime = time.time()
1408
os.utime(path, (self._creation_mtime, self._creation_mtime))
1410
def create_hardlink(self, path, trans_id):
1411
"""Schedule creation of a hard link"""
1412
name = self._limbo_name(trans_id)
1415
except OSError as e:
1416
if e.errno != errno.EPERM:
1418
raise errors.HardLinkNotSupported(path)
1420
unique_add(self._new_contents, trans_id, 'file')
1421
except BaseException:
1422
# Clean up the file, it never got registered so
1423
# TreeTransform.finalize() won't clean it up.
1427
def create_directory(self, trans_id):
1428
"""Schedule creation of a new directory.
1430
See also new_directory.
1432
os.mkdir(self._limbo_name(trans_id))
1433
unique_add(self._new_contents, trans_id, 'directory')
1435
def create_symlink(self, target, trans_id):
1436
"""Schedule creation of a new symbolic link.
1438
target is a bytestring.
1439
See also new_symlink.
1441
if self._create_symlinks:
1442
os.symlink(target, self._limbo_name(trans_id))
1445
path = FinalPaths(self).get_path(trans_id)
1449
'Unable to create symlink "%s" on this filesystem.' % (path,))
1450
# We add symlink to _new_contents even if they are unsupported
1451
# and not created. These entries are subsequently used to avoid
1452
# conflicts on platforms that don't support symlink
1453
unique_add(self._new_contents, trans_id, 'symlink')
1455
def cancel_creation(self, trans_id):
1456
"""Cancel the creation of new file contents."""
1457
del self._new_contents[trans_id]
1458
if trans_id in self._observed_sha1s:
1459
del self._observed_sha1s[trans_id]
1460
children = self._limbo_children.get(trans_id)
1461
# if this is a limbo directory with children, move them before removing
1463
if children is not None:
1464
self._rename_in_limbo(children)
1465
del self._limbo_children[trans_id]
1466
del self._limbo_children_names[trans_id]
1467
delete_any(self._limbo_name(trans_id))
1469
def new_orphan(self, trans_id, parent_id):
1470
conf = self._tree.get_config_stack()
1471
handle_orphan = conf.get('transform.orphan_policy')
1472
handle_orphan(self, trans_id, parent_id)
1475
class OrphaningError(errors.BzrError):
1477
# Only bugs could lead to such exception being seen by the user
1478
internal_error = True
1479
_fmt = "Error while orphaning %s in %s directory"
1481
def __init__(self, orphan, parent):
1482
errors.BzrError.__init__(self)
1483
self.orphan = orphan
1484
self.parent = parent
1487
class OrphaningForbidden(OrphaningError):
1489
_fmt = "Policy: %s doesn't allow creating orphans."
1491
def __init__(self, policy):
1492
errors.BzrError.__init__(self)
1493
self.policy = policy
1496
def move_orphan(tt, orphan_id, parent_id):
1497
"""See TreeTransformBase.new_orphan.
1499
This creates a new orphan in the `brz-orphans` dir at the root of the
1502
:param tt: The TreeTransform orphaning `trans_id`.
1504
:param orphan_id: The trans id that should be orphaned.
1506
:param parent_id: The orphan parent trans id.
1508
# Add the orphan dir if it doesn't exist
1509
orphan_dir_basename = 'brz-orphans'
1510
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1511
if tt.final_kind(od_id) is None:
1512
tt.create_directory(od_id)
1513
parent_path = tt._tree_id_paths[parent_id]
1514
# Find a name that doesn't exist yet in the orphan dir
1515
actual_name = tt.final_name(orphan_id)
1516
new_name = tt._available_backup_name(actual_name, od_id)
1517
tt.adjust_path(new_name, od_id, orphan_id)
1518
trace.warning('%s has been orphaned in %s'
1519
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1522
def refuse_orphan(tt, orphan_id, parent_id):
1523
"""See TreeTransformBase.new_orphan.
1525
This refuses to create orphan, letting the caller handle the conflict.
1527
raise OrphaningForbidden('never')
1530
orphaning_registry = registry.Registry()
1531
orphaning_registry.register(
1532
u'conflict', refuse_orphan,
1533
'Leave orphans in place and create a conflict on the directory.')
1534
orphaning_registry.register(
1535
u'move', move_orphan,
1536
'Move orphans into the brz-orphans directory.')
1537
orphaning_registry._set_default_key(u'conflict')
1540
opt_transform_orphan = _mod_config.RegistryOption(
1541
'transform.orphan_policy', orphaning_registry,
1542
help='Policy for orphaned files during transform operations.',
1546
class TreeTransform(DiskTreeTransform):
1547
"""Represent a tree transformation.
1549
This object is designed to support incremental generation of the transform,
1552
However, it gives optimum performance when parent directories are created
1553
before their contents. The transform is then able to put child files
1554
directly in their parent directory, avoiding later renames.
1556
It is easy to produce malformed transforms, but they are generally
1557
harmless. Attempting to apply a malformed transform will cause an
1558
exception to be raised before any modifications are made to the tree.
1560
Many kinds of malformed transforms can be corrected with the
1561
resolve_conflicts function. The remaining ones indicate programming error,
1562
such as trying to create a file with no path.
1564
Two sets of file creation methods are supplied. Convenience methods are:
1569
These are composed of the low-level methods:
1571
* create_file or create_directory or create_symlink
1575
Transform/Transaction ids
1576
-------------------------
1577
trans_ids are temporary ids assigned to all files involved in a transform.
1578
It's possible, even common, that not all files in the Tree have trans_ids.
1580
trans_ids are used because filenames and file_ids are not good enough
1581
identifiers; filenames change, and not all files have file_ids. File-ids
1582
are also associated with trans-ids, so that moving a file moves its
1585
trans_ids are only valid for the TreeTransform that generated them.
1589
Limbo is a temporary directory use to hold new versions of files.
1590
Files are added to limbo by create_file, create_directory, create_symlink,
1591
and their convenience variants (new_*). Files may be removed from limbo
1592
using cancel_creation. Files are renamed from limbo into their final
1593
location as part of TreeTransform.apply
1595
Limbo must be cleaned up, by either calling TreeTransform.apply or
1596
calling TreeTransform.finalize.
1598
Files are placed into limbo inside their parent directories, where
1599
possible. This reduces subsequent renames, and makes operations involving
1600
lots of files faster. This optimization is only possible if the parent
1601
directory is created *before* creating any of its children, so avoid
1602
creating children before parents, where possible.
1606
This temporary directory is used by _FileMover for storing files that are
1607
about to be deleted. In case of rollback, the files will be restored.
1608
FileMover does not delete files until it is sure that a rollback will not
1612
def __init__(self, tree, pb=None):
1613
"""Note: a tree_write lock is taken on the tree.
1615
Use TreeTransform.finalize() to release the lock (can be omitted if
1616
TreeTransform.apply() called).
1618
tree.lock_tree_write()
1620
limbodir = urlutils.local_path_from_url(
1621
tree._transport.abspath('limbo'))
1622
osutils.ensure_empty_directory_exists(
1624
errors.ExistingLimbo)
1625
deletiondir = urlutils.local_path_from_url(
1626
tree._transport.abspath('pending-deletion'))
1627
osutils.ensure_empty_directory_exists(
1629
errors.ExistingPendingDeletion)
1630
except BaseException:
1634
# Cache of realpath results, to speed up canonical_path
1635
self._realpaths = {}
1636
# Cache of relpath results, to speed up canonical_path
1638
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1639
tree.case_sensitive)
1640
self._deletiondir = deletiondir
1642
def canonical_path(self, path):
1643
"""Get the canonical tree-relative path"""
1644
# don't follow final symlinks
1645
abs = self._tree.abspath(path)
1646
if abs in self._relpaths:
1647
return self._relpaths[abs]
1648
dirname, basename = os.path.split(abs)
1649
if dirname not in self._realpaths:
1650
self._realpaths[dirname] = os.path.realpath(dirname)
1651
dirname = self._realpaths[dirname]
1652
abs = pathjoin(dirname, basename)
1653
if dirname in self._relpaths:
1654
relpath = pathjoin(self._relpaths[dirname], basename)
1655
relpath = relpath.rstrip('/\\')
1657
relpath = self._tree.relpath(abs)
1658
self._relpaths[abs] = relpath
1661
def tree_kind(self, trans_id):
1662
"""Determine the file kind in the working tree.
1664
:returns: The file kind or None if the file does not exist
1666
path = self._tree_id_paths.get(trans_id)
1670
return file_kind(self._tree.abspath(path))
1671
except errors.NoSuchFile:
1674
def _set_mode(self, trans_id, mode_id, typefunc):
1675
"""Set the mode of new file contents.
1676
The mode_id is the existing file to get the mode from (often the same
1677
as trans_id). The operation is only performed if there's a mode match
1678
according to typefunc.
1683
old_path = self._tree_id_paths[mode_id]
1687
mode = os.stat(self._tree.abspath(old_path)).st_mode
1688
except OSError as e:
1689
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1690
# Either old_path doesn't exist, or the parent of the
1691
# target is not a directory (but will be one eventually)
1692
# Either way, we know it doesn't exist *right now*
1693
# See also bug #248448
1698
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1700
def iter_tree_children(self, parent_id):
1701
"""Iterate through the entry's tree children, if any"""
1703
path = self._tree_id_paths[parent_id]
1707
children = os.listdir(self._tree.abspath(path))
1708
except OSError as e:
1709
if not (osutils._is_error_enotdir(e) or
1710
e.errno in (errno.ENOENT, errno.ESRCH)):
1714
for child in children:
1715
childpath = joinpath(path, child)
1716
if self._tree.is_control_filename(childpath):
1718
yield self.trans_id_tree_path(childpath)
1720
def _generate_limbo_path(self, trans_id):
1721
"""Generate a limbo path using the final path if possible.
1723
This optimizes the performance of applying the tree transform by
1724
avoiding renames. These renames can be avoided only when the parent
1725
directory is already scheduled for creation.
1727
If the final path cannot be used, falls back to using the trans_id as
1730
parent = self._new_parent.get(trans_id)
1731
# if the parent directory is already in limbo (e.g. when building a
1732
# tree), choose a limbo name inside the parent, to reduce further
1734
use_direct_path = False
1735
if self._new_contents.get(parent) == 'directory':
1736
filename = self._new_name.get(trans_id)
1737
if filename is not None:
1738
if parent not in self._limbo_children:
1739
self._limbo_children[parent] = set()
1740
self._limbo_children_names[parent] = {}
1741
use_direct_path = True
1742
# the direct path can only be used if no other file has
1743
# already taken this pathname, i.e. if the name is unused, or
1744
# if it is already associated with this trans_id.
1745
elif self._case_sensitive_target:
1746
if (self._limbo_children_names[parent].get(filename)
1747
in (trans_id, None)):
1748
use_direct_path = True
1750
for l_filename, l_trans_id in viewitems(
1751
self._limbo_children_names[parent]):
1752
if l_trans_id == trans_id:
1754
if l_filename.lower() == filename.lower():
1757
use_direct_path = True
1759
if not use_direct_path:
1760
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1762
limbo_name = pathjoin(self._limbo_files[parent], filename)
1763
self._limbo_children[parent].add(trans_id)
1764
self._limbo_children_names[parent][filename] = trans_id
1767
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1768
"""Apply all changes to the inventory and filesystem.
1770
If filesystem or inventory conflicts are present, MalformedTransform
1773
If apply succeeds, finalize is not necessary.
1775
:param no_conflicts: if True, the caller guarantees there are no
1776
conflicts, so no check is made.
1777
:param precomputed_delta: An inventory delta to use instead of
1779
:param _mover: Supply an alternate FileMover, for testing
1781
for hook in MutableTree.hooks['pre_transform']:
1782
hook(self._tree, self)
1783
if not no_conflicts:
1784
self._check_malformed()
1785
with ui.ui_factory.nested_progress_bar() as child_pb:
1786
if precomputed_delta is None:
1787
child_pb.update(gettext('Apply phase'), 0, 2)
1788
inventory_delta = self._generate_inventory_delta()
1791
inventory_delta = precomputed_delta
1794
mover = _FileMover()
1798
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1799
self._apply_removals(mover)
1800
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1801
modified_paths = self._apply_insertions(mover)
1802
except BaseException:
1806
mover.apply_deletions()
1807
if self.final_file_id(self.root) is None:
1808
inventory_delta = [e for e in inventory_delta if e[0] != '']
1809
self._tree.apply_inventory_delta(inventory_delta)
1810
self._apply_observed_sha1s()
1813
return _TransformResults(modified_paths, self.rename_count)
1815
def _generate_inventory_delta(self):
1816
"""Generate an inventory delta for the current transform."""
1817
inventory_delta = []
1818
new_paths = self._inventory_altered()
1819
total_entries = len(new_paths) + len(self._removed_id)
1820
with ui.ui_factory.nested_progress_bar() as child_pb:
1821
for num, trans_id in enumerate(self._removed_id):
1823
child_pb.update(gettext('removing file'),
1825
if trans_id == self._new_root:
1826
file_id = self._tree.path2id('')
1828
file_id = self.tree_file_id(trans_id)
1829
# File-id isn't really being deleted, just moved
1830
if file_id in self._r_new_id:
1832
path = self._tree_id_paths[trans_id]
1833
inventory_delta.append((path, None, file_id, None))
1834
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1836
for num, (path, trans_id) in enumerate(new_paths):
1838
child_pb.update(gettext('adding file'),
1839
num + len(self._removed_id), total_entries)
1840
file_id = new_path_file_ids[trans_id]
1843
kind = self.final_kind(trans_id)
1845
kind = self._tree.stored_kind(self._tree.id2path(file_id))
1846
parent_trans_id = self.final_parent(trans_id)
1847
parent_file_id = new_path_file_ids.get(parent_trans_id)
1848
if parent_file_id is None:
1849
parent_file_id = self.final_file_id(parent_trans_id)
1850
if trans_id in self._new_reference_revision:
1851
new_entry = inventory.TreeReference(
1853
self._new_name[trans_id],
1854
self.final_file_id(self._new_parent[trans_id]),
1855
None, self._new_reference_revision[trans_id])
1857
new_entry = inventory.make_entry(kind,
1858
self.final_name(trans_id),
1859
parent_file_id, file_id)
1861
old_path = self._tree.id2path(new_entry.file_id)
1862
except errors.NoSuchId:
1864
new_executability = self._new_executability.get(trans_id)
1865
if new_executability is not None:
1866
new_entry.executable = new_executability
1867
inventory_delta.append(
1868
(old_path, path, new_entry.file_id, new_entry))
1869
return inventory_delta
1871
def _apply_removals(self, mover):
1872
"""Perform tree operations that remove directory/inventory names.
1874
That is, delete files that are to be deleted, and put any files that
1875
need renaming into limbo. This must be done in strict child-to-parent
1878
If inventory_delta is None, no inventory delta generation is performed.
1880
tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
1881
with ui.ui_factory.nested_progress_bar() as child_pb:
1882
for num, (path, trans_id) in enumerate(tree_paths):
1883
# do not attempt to move root into a subdirectory of itself.
1886
child_pb.update(gettext('removing file'), num, len(tree_paths))
1887
full_path = self._tree.abspath(path)
1888
if trans_id in self._removed_contents:
1889
delete_path = os.path.join(self._deletiondir, trans_id)
1890
mover.pre_delete(full_path, delete_path)
1891
elif (trans_id in self._new_name or
1892
trans_id in self._new_parent):
1894
mover.rename(full_path, self._limbo_name(trans_id))
1895
except errors.TransformRenameFailed as e:
1896
if e.errno != errno.ENOENT:
1899
self.rename_count += 1
1901
def _apply_insertions(self, mover):
1902
"""Perform tree operations that insert directory/inventory names.
1904
That is, create any files that need to be created, and restore from
1905
limbo any files that needed renaming. This must be done in strict
1906
parent-to-child order.
1908
If inventory_delta is None, no inventory delta is calculated, and
1909
no list of modified paths is returned.
1911
new_paths = self.new_paths(filesystem_only=True)
1913
with ui.ui_factory.nested_progress_bar() as child_pb:
1914
for num, (path, trans_id) in enumerate(new_paths):
1916
child_pb.update(gettext('adding file'),
1917
num, len(new_paths))
1918
full_path = self._tree.abspath(path)
1919
if trans_id in self._needs_rename:
1921
mover.rename(self._limbo_name(trans_id), full_path)
1922
except errors.TransformRenameFailed as e:
1923
# We may be renaming a dangling inventory id
1924
if e.errno != errno.ENOENT:
1927
self.rename_count += 1
1928
# TODO: if trans_id in self._observed_sha1s, we should
1929
# re-stat the final target, since ctime will be
1930
# updated by the change.
1931
if (trans_id in self._new_contents
1932
or self.path_changed(trans_id)):
1933
if trans_id in self._new_contents:
1934
modified_paths.append(full_path)
1935
if trans_id in self._new_executability:
1936
self._set_executability(path, trans_id)
1937
if trans_id in self._observed_sha1s:
1938
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1939
st = osutils.lstat(full_path)
1940
self._observed_sha1s[trans_id] = (o_sha1, st)
1941
for path, trans_id in new_paths:
1942
# new_paths includes stuff like workingtree conflicts. Only the
1943
# stuff in new_contents actually comes from limbo.
1944
if trans_id in self._limbo_files:
1945
del self._limbo_files[trans_id]
1946
self._new_contents.clear()
1947
return modified_paths
1949
def _apply_observed_sha1s(self):
1950
"""After we have finished renaming everything, update observed sha1s
1952
This has to be done after self._tree.apply_inventory_delta, otherwise
1953
it doesn't know anything about the files we are updating. Also, we want
1954
to do this as late as possible, so that most entries end up cached.
1956
# TODO: this doesn't update the stat information for directories. So
1957
# the first 'bzr status' will still need to rewrite
1958
# .bzr/checkout/dirstate. However, we at least don't need to
1959
# re-read all of the files.
1960
# TODO: If the operation took a while, we could do a time.sleep(3) here
1961
# to allow the clock to tick over and ensure we won't have any
1962
# problems. (we could observe start time, and finish time, and if
1963
# it is less than eg 10% overhead, add a sleep call.)
1964
paths = FinalPaths(self)
1965
for trans_id, observed in viewitems(self._observed_sha1s):
1966
path = paths.get_path(trans_id)
1967
self._tree._observed_sha1(path, observed)
1970
class TransformPreview(DiskTreeTransform):
1971
"""A TreeTransform for generating preview trees.
1973
Unlike TreeTransform, this version works when the input tree is a
1974
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1975
unversioned files in the input tree.
1978
def __init__(self, tree, pb=None, case_sensitive=True):
1980
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1981
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1983
def canonical_path(self, path):
1986
def tree_kind(self, trans_id):
1987
path = self._tree_id_paths.get(trans_id)
1990
kind = self._tree.path_content_summary(path)[0]
1991
if kind == 'missing':
1995
def _set_mode(self, trans_id, mode_id, typefunc):
1996
"""Set the mode of new file contents.
1997
The mode_id is the existing file to get the mode from (often the same
1998
as trans_id). The operation is only performed if there's a mode match
1999
according to typefunc.
2001
# is it ok to ignore this? probably
2004
def iter_tree_children(self, parent_id):
2005
"""Iterate through the entry's tree children, if any"""
2007
path = self._tree_id_paths[parent_id]
2011
entry = next(self._tree.iter_entries_by_dir(
2012
specific_files=[path]))[1]
2013
except StopIteration:
2015
children = getattr(entry, 'children', {})
2016
for child in children:
2017
childpath = joinpath(path, child)
2018
yield self.trans_id_tree_path(childpath)
2020
def new_orphan(self, trans_id, parent_id):
2021
raise NotImplementedError(self.new_orphan)
2024
class _PreviewTree(inventorytree.InventoryTree):
2025
"""Partial implementation of Tree to support show_diff_trees"""
2027
def __init__(self, transform):
2028
self._transform = transform
2029
self._final_paths = FinalPaths(transform)
2030
self.__by_parent = None
2031
self._parent_ids = []
2032
self._all_children_cache = {}
2033
self._path2trans_id_cache = {}
2034
self._final_name_cache = {}
2035
self._iter_changes_cache = dict((c.file_id, c) for c in
2036
self._transform.iter_changes())
2038
def _content_change(self, file_id):
2039
"""Return True if the content of this file changed"""
2040
changes = self._iter_changes_cache.get(file_id)
2041
# changes[2] is true if the file content changed. See
2042
# InterTree.iter_changes.
2043
return (changes is not None and changes[2])
2045
def _get_repository(self):
2046
repo = getattr(self._transform._tree, '_repository', None)
2048
repo = self._transform._tree.branch.repository
2051
def _iter_parent_trees(self):
2052
for revision_id in self.get_parent_ids():
2054
yield self.revision_tree(revision_id)
2055
except errors.NoSuchRevisionInTree:
2056
yield self._get_repository().revision_tree(revision_id)
2058
def _get_file_revision(self, path, file_id, vf, tree_revision):
2060
(file_id, t.get_file_revision(t.id2path(file_id)))
2061
for t in self._iter_parent_trees()]
2062
vf.add_lines((file_id, tree_revision), parent_keys,
2063
self.get_file_lines(path))
2064
repo = self._get_repository()
2065
base_vf = repo.texts
2066
if base_vf not in vf.fallback_versionedfiles:
2067
vf.fallback_versionedfiles.append(base_vf)
2068
return tree_revision
2070
def _stat_limbo_file(self, trans_id):
2071
name = self._transform._limbo_name(trans_id)
2072
return os.lstat(name)
2075
def _by_parent(self):
2076
if self.__by_parent is None:
2077
self.__by_parent = self._transform.by_parent()
2078
return self.__by_parent
2080
def _comparison_data(self, entry, path):
2081
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2082
if kind == 'missing':
2086
file_id = self._transform.final_file_id(self._path2trans_id(path))
2087
executable = self.is_executable(path)
2088
return kind, executable, None
2090
def is_locked(self):
2093
def lock_read(self):
2094
# Perhaps in theory, this should lock the TreeTransform?
2095
return lock.LogicalLockResult(self.unlock)
2101
def root_inventory(self):
2102
"""This Tree does not use inventory as its backing data."""
2103
raise NotImplementedError(_PreviewTree.root_inventory)
2105
def all_file_ids(self):
2106
tree_ids = set(self._transform._tree.all_file_ids())
2107
tree_ids.difference_update(self._transform.tree_file_id(t)
2108
for t in self._transform._removed_id)
2109
tree_ids.update(viewvalues(self._transform._new_id))
2112
def all_versioned_paths(self):
2113
tree_paths = set(self._transform._tree.all_versioned_paths())
2115
tree_paths.difference_update(
2116
self._transform.trans_id_tree_path(t)
2117
for t in self._transform._removed_id)
2120
self._final_paths._determine_path(t)
2121
for t in self._transform._new_id)
2125
def _has_id(self, file_id, fallback_check):
2126
if file_id in self._transform._r_new_id:
2128
elif file_id in {self._transform.tree_file_id(trans_id) for
2129
trans_id in self._transform._removed_id}:
2132
return fallback_check(file_id)
2134
def has_id(self, file_id):
2135
return self._has_id(file_id, self._transform._tree.has_id)
2137
def has_or_had_id(self, file_id):
2138
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2140
def _path2trans_id(self, path):
2141
# We must not use None here, because that is a valid value to store.
2142
trans_id = self._path2trans_id_cache.get(path, object)
2143
if trans_id is not object:
2145
segments = splitpath(path)
2146
cur_parent = self._transform.root
2147
for cur_segment in segments:
2148
for child in self._all_children(cur_parent):
2149
final_name = self._final_name_cache.get(child)
2150
if final_name is None:
2151
final_name = self._transform.final_name(child)
2152
self._final_name_cache[child] = final_name
2153
if final_name == cur_segment:
2157
self._path2trans_id_cache[path] = None
2159
self._path2trans_id_cache[path] = cur_parent
2162
def path2id(self, path):
2163
if isinstance(path, list):
2166
path = osutils.pathjoin(*path)
2167
return self._transform.final_file_id(self._path2trans_id(path))
2169
def id2path(self, file_id):
2170
trans_id = self._transform.trans_id_file_id(file_id)
2172
return self._final_paths._determine_path(trans_id)
2174
raise errors.NoSuchId(self, file_id)
2176
def _all_children(self, trans_id):
2177
children = self._all_children_cache.get(trans_id)
2178
if children is not None:
2180
children = set(self._transform.iter_tree_children(trans_id))
2181
# children in the _new_parent set are provided by _by_parent.
2182
children.difference_update(self._transform._new_parent)
2183
children.update(self._by_parent.get(trans_id, []))
2184
self._all_children_cache[trans_id] = children
2187
def _iter_children(self, file_id):
2188
trans_id = self._transform.trans_id_file_id(file_id)
2189
for child_trans_id in self._all_children(trans_id):
2190
yield self._transform.final_file_id(child_trans_id)
2193
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2194
in self._transform._tree.extras())
2195
possible_extras.update(self._transform._new_contents)
2196
possible_extras.update(self._transform._removed_id)
2197
for trans_id in possible_extras:
2198
if self._transform.final_file_id(trans_id) is None:
2199
yield self._final_paths._determine_path(trans_id)
2201
def _make_inv_entries(self, ordered_entries, specific_files=None):
2202
for trans_id, parent_file_id in ordered_entries:
2203
file_id = self._transform.final_file_id(trans_id)
2206
if (specific_files is not None
2207
and self._final_paths.get_path(trans_id) not in specific_files):
2209
kind = self._transform.final_kind(trans_id)
2211
kind = self._transform._tree.stored_kind(
2212
self._transform._tree.id2path(file_id))
2213
new_entry = inventory.make_entry(
2215
self._transform.final_name(trans_id),
2216
parent_file_id, file_id)
2217
yield new_entry, trans_id
2219
def _list_files_by_dir(self):
2220
todo = [ROOT_PARENT]
2222
while len(todo) > 0:
2224
parent_file_id = self._transform.final_file_id(parent)
2225
children = list(self._all_children(parent))
2226
paths = dict(zip(children, self._final_paths.get_paths(children)))
2227
children.sort(key=paths.get)
2228
todo.extend(reversed(children))
2229
for trans_id in children:
2230
ordered_ids.append((trans_id, parent_file_id))
2233
def iter_child_entries(self, path):
2234
trans_id = self._path2trans_id(path)
2235
if trans_id is None:
2236
raise errors.NoSuchFile(path)
2237
todo = [(child_trans_id, trans_id) for child_trans_id in
2238
self._all_children(trans_id)]
2239
for entry, trans_id in self._make_inv_entries(todo):
2242
def iter_entries_by_dir(self, specific_files=None):
2243
# This may not be a maximally efficient implementation, but it is
2244
# reasonably straightforward. An implementation that grafts the
2245
# TreeTransform changes onto the tree's iter_entries_by_dir results
2246
# might be more efficient, but requires tricky inferences about stack
2248
ordered_ids = self._list_files_by_dir()
2249
for entry, trans_id in self._make_inv_entries(ordered_ids,
2251
yield self._final_paths.get_path(trans_id), entry
2253
def _iter_entries_for_dir(self, dir_path):
2254
"""Return path, entry for items in a directory without recursing down."""
2256
dir_trans_id = self._path2trans_id(dir_path)
2257
dir_id = self._transform.final_file_id(dir_trans_id)
2258
for child_trans_id in self._all_children(dir_trans_id):
2259
ordered_ids.append((child_trans_id, dir_id))
2261
for entry, trans_id in self._make_inv_entries(ordered_ids):
2262
path_entries.append((self._final_paths.get_path(trans_id), entry))
2266
def list_files(self, include_root=False, from_dir=None, recursive=True):
2267
"""See WorkingTree.list_files."""
2268
# XXX This should behave like WorkingTree.list_files, but is really
2269
# more like RevisionTree.list_files.
2275
prefix = from_dir + '/'
2276
entries = self.iter_entries_by_dir()
2277
for path, entry in entries:
2278
if entry.name == '' and not include_root:
2281
if not path.startswith(prefix):
2283
path = path[len(prefix):]
2284
yield path, 'V', entry.kind, entry
2286
if from_dir is None and include_root is True:
2287
root_entry = inventory.make_entry(
2288
'directory', '', ROOT_PARENT, self.path2id(''))
2289
yield '', 'V', 'directory', root_entry
2290
entries = self._iter_entries_for_dir(from_dir or '')
2291
for path, entry in entries:
2292
yield path, 'V', entry.kind, entry
2294
def kind(self, path):
2295
trans_id = self._path2trans_id(path)
2296
if trans_id is None:
2297
raise errors.NoSuchFile(path)
2298
return self._transform.final_kind(trans_id)
2300
def stored_kind(self, path):
2301
trans_id = self._path2trans_id(path)
2302
if trans_id is None:
2303
raise errors.NoSuchFile(path)
2305
return self._transform._new_contents[trans_id]
2307
return self._transform._tree.stored_kind(path)
2309
def get_file_mtime(self, path):
2310
"""See Tree.get_file_mtime"""
2311
file_id = self.path2id(path)
2313
raise errors.NoSuchFile(path)
2314
if not self._content_change(file_id):
2315
return self._transform._tree.get_file_mtime(
2316
self._transform._tree.id2path(file_id))
2317
trans_id = self._path2trans_id(path)
2318
return self._stat_limbo_file(trans_id).st_mtime
2320
def get_file_size(self, path):
2321
"""See Tree.get_file_size"""
2322
trans_id = self._path2trans_id(path)
2323
if trans_id is None:
2324
raise errors.NoSuchFile(path)
2325
kind = self._transform.final_kind(trans_id)
2328
if trans_id in self._transform._new_contents:
2329
return self._stat_limbo_file(trans_id).st_size
2330
if self.kind(path) == 'file':
2331
return self._transform._tree.get_file_size(path)
2335
def get_file_verifier(self, path, stat_value=None):
2336
trans_id = self._path2trans_id(path)
2337
if trans_id is None:
2338
raise errors.NoSuchFile(path)
2339
kind = self._transform._new_contents.get(trans_id)
2341
return self._transform._tree.get_file_verifier(path)
2343
with self.get_file(path) as fileobj:
2344
return ("SHA1", sha_file(fileobj))
2346
def get_file_sha1(self, path, stat_value=None):
2347
trans_id = self._path2trans_id(path)
2348
if trans_id is None:
2349
raise errors.NoSuchFile(path)
2350
kind = self._transform._new_contents.get(trans_id)
2352
return self._transform._tree.get_file_sha1(path)
2354
with self.get_file(path) as fileobj:
2355
return sha_file(fileobj)
2357
def is_executable(self, path):
2358
trans_id = self._path2trans_id(path)
2359
if trans_id is None:
2362
return self._transform._new_executability[trans_id]
2365
return self._transform._tree.is_executable(path)
2366
except OSError as e:
2367
if e.errno == errno.ENOENT:
2370
except errors.NoSuchFile:
2373
def has_filename(self, path):
2374
trans_id = self._path2trans_id(path)
2375
if trans_id in self._transform._new_contents:
2377
elif trans_id in self._transform._removed_contents:
2380
return self._transform._tree.has_filename(path)
2382
def path_content_summary(self, path):
2383
trans_id = self._path2trans_id(path)
2384
tt = self._transform
2385
tree_path = tt._tree_id_paths.get(trans_id)
2386
kind = tt._new_contents.get(trans_id)
2388
if tree_path is None or trans_id in tt._removed_contents:
2389
return 'missing', None, None, None
2390
summary = tt._tree.path_content_summary(tree_path)
2391
kind, size, executable, link_or_sha1 = summary
2394
limbo_name = tt._limbo_name(trans_id)
2395
if trans_id in tt._new_reference_revision:
2396
kind = 'tree-reference'
2398
statval = os.lstat(limbo_name)
2399
size = statval.st_size
2400
if not tt._limbo_supports_executable():
2403
executable = statval.st_mode & S_IEXEC
2407
if kind == 'symlink':
2408
link_or_sha1 = os.readlink(limbo_name)
2409
if not isinstance(link_or_sha1, text_type):
2410
link_or_sha1 = link_or_sha1.decode(osutils._fs_enc)
2411
executable = tt._new_executability.get(trans_id, executable)
2412
return kind, size, executable, link_or_sha1
2414
def iter_changes(self, from_tree, include_unchanged=False,
2415
specific_files=None, pb=None, extra_trees=None,
2416
require_versioned=True, want_unversioned=False):
2417
"""See InterTree.iter_changes.
2419
This has a fast path that is only used when the from_tree matches
2420
the transform tree, and no fancy options are supplied.
2422
if (from_tree is not self._transform._tree or include_unchanged
2423
or specific_files or want_unversioned):
2424
return tree.InterTree(from_tree, self).iter_changes(
2425
include_unchanged=include_unchanged,
2426
specific_files=specific_files,
2428
extra_trees=extra_trees,
2429
require_versioned=require_versioned,
2430
want_unversioned=want_unversioned)
2431
if want_unversioned:
2432
raise ValueError('want_unversioned is not supported')
2433
return self._transform.iter_changes()
2435
def get_file(self, path):
2436
"""See Tree.get_file"""
2437
file_id = self.path2id(path)
2438
if not self._content_change(file_id):
2439
return self._transform._tree.get_file(path)
2440
trans_id = self._path2trans_id(path)
2441
name = self._transform._limbo_name(trans_id)
2442
return open(name, 'rb')
2444
def get_file_with_stat(self, path):
2445
return self.get_file(path), None
2447
def annotate_iter(self, path,
2448
default_revision=_mod_revision.CURRENT_REVISION):
2449
file_id = self.path2id(path)
2450
changes = self._iter_changes_cache.get(file_id)
2454
changed_content, versioned, kind = (
2455
changes.changed_content, changes.versioned, changes.kind)
2458
get_old = (kind[0] == 'file' and versioned[0])
2460
old_annotation = self._transform._tree.annotate_iter(
2461
path, default_revision=default_revision)
2465
return old_annotation
2466
if not changed_content:
2467
return old_annotation
2468
# TODO: This is doing something similar to what WT.annotate_iter is
2469
# doing, however it fails slightly because it doesn't know what
2470
# the *other* revision_id is, so it doesn't know how to give the
2471
# other as the origin for some lines, they all get
2472
# 'default_revision'
2473
# It would be nice to be able to use the new Annotator based
2474
# approach, as well.
2475
return annotate.reannotate([old_annotation],
2476
self.get_file(path).readlines(),
2479
def get_symlink_target(self, path):
2480
"""See Tree.get_symlink_target"""
2481
file_id = self.path2id(path)
2482
if not self._content_change(file_id):
2483
return self._transform._tree.get_symlink_target(path)
2484
trans_id = self._path2trans_id(path)
2485
name = self._transform._limbo_name(trans_id)
2486
return osutils.readlink(name)
2488
def walkdirs(self, prefix=''):
2489
pending = [self._transform.root]
2490
while len(pending) > 0:
2491
parent_id = pending.pop()
2494
prefix = prefix.rstrip('/')
2495
parent_path = self._final_paths.get_path(parent_id)
2496
parent_file_id = self._transform.final_file_id(parent_id)
2497
for child_id in self._all_children(parent_id):
2498
path_from_root = self._final_paths.get_path(child_id)
2499
basename = self._transform.final_name(child_id)
2500
file_id = self._transform.final_file_id(child_id)
2501
kind = self._transform.final_kind(child_id)
2502
if kind is not None:
2503
versioned_kind = kind
2506
versioned_kind = self._transform._tree.stored_kind(
2507
self._transform._tree.id2path(file_id))
2508
if versioned_kind == 'directory':
2509
subdirs.append(child_id)
2510
children.append((path_from_root, basename, kind, None,
2511
file_id, versioned_kind))
2513
if parent_path.startswith(prefix):
2514
yield (parent_path, parent_file_id), children
2515
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2518
def get_parent_ids(self):
2519
return self._parent_ids
2521
def set_parent_ids(self, parent_ids):
2522
self._parent_ids = parent_ids
2524
def get_revision_tree(self, revision_id):
2525
return self._transform._tree.get_revision_tree(revision_id)
2528
def joinpath(parent, child):
2529
"""Join tree-relative paths, handling the tree root specially"""
2530
if parent is None or parent == "":
2533
return pathjoin(parent, child)
2536
class FinalPaths(object):
2537
"""Make path calculation cheap by memoizing paths.
2539
The underlying tree must not be manipulated between calls, or else
2540
the results will likely be incorrect.
2543
def __init__(self, transform):
2544
object.__init__(self)
2545
self._known_paths = {}
2546
self.transform = transform
2548
def _determine_path(self, trans_id):
2549
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2551
name = self.transform.final_name(trans_id)
2552
parent_id = self.transform.final_parent(trans_id)
2553
if parent_id == self.transform.root:
2556
return pathjoin(self.get_path(parent_id), name)
2558
def get_path(self, trans_id):
2559
"""Find the final path associated with a trans_id"""
2560
if trans_id not in self._known_paths:
2561
self._known_paths[trans_id] = self._determine_path(trans_id)
2562
return self._known_paths[trans_id]
2564
def get_paths(self, trans_ids):
2565
return [(self.get_path(t), t) for t in trans_ids]
2568
def topology_sorted_ids(tree):
2569
"""Determine the topological order of the ids in a tree"""
2570
file_ids = list(tree)
2571
file_ids.sort(key=tree.id2path)
2575
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2576
delta_from_tree=False):
2577
"""Create working tree for a branch, using a TreeTransform.
2579
This function should be used on empty trees, having a tree root at most.
2580
(see merge and revert functionality for working with existing trees)
2582
Existing files are handled like so:
2584
- Existing bzrdirs take precedence over creating new items. They are
2585
created as '%s.diverted' % name.
2586
- Otherwise, if the content on disk matches the content we are building,
2587
it is silently replaced.
2588
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2590
:param tree: The tree to convert wt into a copy of
2591
:param wt: The working tree that files will be placed into
2592
:param accelerator_tree: A tree which can be used for retrieving file
2593
contents more quickly than tree itself, i.e. a workingtree. tree
2594
will be used for cases where accelerator_tree's content is different.
2595
:param hardlink: If true, hard-link files to accelerator_tree, where
2596
possible. accelerator_tree must implement abspath, i.e. be a
2598
:param delta_from_tree: If true, build_tree may use the input Tree to
2599
generate the inventory delta.
2601
with wt.lock_tree_write(), tree.lock_read():
2602
if accelerator_tree is not None:
2603
accelerator_tree.lock_read()
2605
return _build_tree(tree, wt, accelerator_tree, hardlink,
2608
if accelerator_tree is not None:
2609
accelerator_tree.unlock()
2612
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2613
"""See build_tree."""
2614
for num, _unused in enumerate(wt.all_versioned_paths()):
2615
if num > 0: # more than just a root
2616
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2618
top_pb = ui.ui_factory.nested_progress_bar()
2619
pp = ProgressPhase("Build phase", 2, top_pb)
2620
if tree.path2id('') is not None:
2621
# This is kind of a hack: we should be altering the root
2622
# as part of the regular tree shape diff logic.
2623
# The conditional test here is to avoid doing an
2624
# expensive operation (flush) every time the root id
2625
# is set within the tree, nor setting the root and thus
2626
# marking the tree as dirty, because we use two different
2627
# idioms here: tree interfaces and inventory interfaces.
2628
if wt.path2id('') != tree.path2id(''):
2629
wt.set_root_id(tree.path2id(''))
2631
tt = wt.get_transform()
2635
file_trans_id[wt.path2id('')] = tt.trans_id_tree_path('')
2636
with ui.ui_factory.nested_progress_bar() as pb:
2637
deferred_contents = []
2639
total = len(tree.all_versioned_paths())
2641
precomputed_delta = []
2643
precomputed_delta = None
2644
# Check if tree inventory has content. If so, we populate
2645
# existing_files with the directory content. If there are no
2646
# entries we skip populating existing_files as its not used.
2647
# This improves performance and unncessary work on large
2648
# directory trees. (#501307)
2650
existing_files = set()
2651
for dir, files in wt.walkdirs():
2652
existing_files.update(f[0] for f in files)
2653
for num, (tree_path, entry) in \
2654
enumerate(tree.iter_entries_by_dir()):
2655
pb.update(gettext("Building tree"), num
2656
- len(deferred_contents), total)
2657
if entry.parent_id is None:
2660
file_id = entry.file_id
2662
precomputed_delta.append((None, tree_path, file_id, entry))
2663
if tree_path in existing_files:
2664
target_path = wt.abspath(tree_path)
2665
kind = file_kind(target_path)
2666
if kind == "directory":
2668
controldir.ControlDir.open(target_path)
2669
except errors.NotBranchError:
2673
if (file_id not in divert
2675
tree, entry, tree_path, kind, target_path)):
2676
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2677
if kind == 'directory':
2679
parent_id = file_trans_id[entry.parent_id]
2680
if entry.kind == 'file':
2681
# We *almost* replicate new_by_entry, so that we can defer
2682
# getting the file text, and get them all at once.
2683
trans_id = tt.create_path(entry.name, parent_id)
2684
file_trans_id[file_id] = trans_id
2685
tt.version_file(file_id, trans_id)
2686
executable = tree.is_executable(tree_path)
2688
tt.set_executability(executable, trans_id)
2689
trans_data = (trans_id, file_id,
2690
tree_path, entry.text_sha1)
2691
deferred_contents.append((tree_path, trans_data))
2693
file_trans_id[file_id] = new_by_entry(
2694
tree_path, tt, entry, parent_id, tree)
2696
new_trans_id = file_trans_id[file_id]
2697
old_parent = tt.trans_id_tree_path(tree_path)
2698
_reparent_children(tt, old_parent, new_trans_id)
2699
offset = num + 1 - len(deferred_contents)
2700
_create_files(tt, tree, deferred_contents, pb, offset,
2701
accelerator_tree, hardlink)
2703
divert_trans = set(file_trans_id[f] for f in divert)
2706
return resolve_checkout(t, c, divert_trans)
2707
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2708
if len(raw_conflicts) > 0:
2709
precomputed_delta = None
2710
conflicts = cook_conflicts(raw_conflicts, tt)
2711
for conflict in conflicts:
2712
trace.warning(text_type(conflict))
2714
wt.add_conflicts(conflicts)
2715
except errors.UnsupportedOperation:
2717
result = tt.apply(no_conflicts=True,
2718
precomputed_delta=precomputed_delta)
2725
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2727
total = len(desired_files) + offset
2729
if accelerator_tree is None:
2730
new_desired_files = desired_files
2732
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2734
change.path for change in iter
2735
if not (change.changed_content or change.executable[0] != change.executable[1])]
2736
if accelerator_tree.supports_content_filtering():
2737
unchanged = [(tp, ap) for (tp, ap) in unchanged
2738
if not next(accelerator_tree.iter_search_rules([ap]))]
2739
unchanged = dict(unchanged)
2740
new_desired_files = []
2742
for unused_tree_path, (trans_id, file_id, tree_path, text_sha1) in desired_files:
2743
accelerator_path = unchanged.get(tree_path)
2744
if accelerator_path is None:
2745
new_desired_files.append((tree_path,
2746
(trans_id, file_id, tree_path, text_sha1)))
2748
pb.update(gettext('Adding file contents'), count + offset, total)
2750
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2753
with accelerator_tree.get_file(accelerator_path) as f:
2754
chunks = osutils.file_iterator(f)
2755
if wt.supports_content_filtering():
2756
filters = wt._content_filter_stack(tree_path)
2757
chunks = filtered_output_bytes(chunks, filters,
2758
ContentFilterContext(tree_path, tree))
2759
tt.create_file(chunks, trans_id, sha1=text_sha1)
2762
for count, ((trans_id, file_id, tree_path, text_sha1), contents) in enumerate(
2763
tree.iter_files_bytes(new_desired_files)):
2764
if wt.supports_content_filtering():
2765
filters = wt._content_filter_stack(tree_path)
2766
contents = filtered_output_bytes(contents, filters,
2767
ContentFilterContext(tree_path, tree))
2768
tt.create_file(contents, trans_id, sha1=text_sha1)
2769
pb.update(gettext('Adding file contents'), count + offset, total)
2772
def _reparent_children(tt, old_parent, new_parent):
2773
for child in tt.iter_tree_children(old_parent):
2774
tt.adjust_path(tt.final_name(child), new_parent, child)
2777
def _reparent_transform_children(tt, old_parent, new_parent):
2778
by_parent = tt.by_parent()
2779
for child in by_parent[old_parent]:
2780
tt.adjust_path(tt.final_name(child), new_parent, child)
2781
return by_parent[old_parent]
2784
def _content_match(tree, entry, tree_path, kind, target_path):
2785
if entry.kind != kind:
2787
if entry.kind == "directory":
2789
if entry.kind == "file":
2790
with open(target_path, 'rb') as f1, \
2791
tree.get_file(tree_path) as f2:
2792
if osutils.compare_files(f1, f2):
2794
elif entry.kind == "symlink":
2795
if tree.get_symlink_target(tree_path) == os.readlink(target_path):
2800
def resolve_checkout(tt, conflicts, divert):
2801
new_conflicts = set()
2802
for c_type, conflict in ((c[0], c) for c in conflicts):
2803
# Anything but a 'duplicate' would indicate programmer error
2804
if c_type != 'duplicate':
2805
raise AssertionError(c_type)
2806
# Now figure out which is new and which is old
2807
if tt.new_contents(conflict[1]):
2808
new_file = conflict[1]
2809
old_file = conflict[2]
2811
new_file = conflict[2]
2812
old_file = conflict[1]
2814
# We should only get here if the conflict wasn't completely
2816
final_parent = tt.final_parent(old_file)
2817
if new_file in divert:
2818
new_name = tt.final_name(old_file) + '.diverted'
2819
tt.adjust_path(new_name, final_parent, new_file)
2820
new_conflicts.add((c_type, 'Diverted to',
2821
new_file, old_file))
2823
new_name = tt.final_name(old_file) + '.moved'
2824
tt.adjust_path(new_name, final_parent, old_file)
2825
new_conflicts.add((c_type, 'Moved existing file to',
2826
old_file, new_file))
2827
return new_conflicts
2830
def new_by_entry(path, tt, entry, parent_id, tree):
2831
"""Create a new file according to its inventory entry"""
2835
with tree.get_file(path) as f:
2836
executable = tree.is_executable(path)
2838
name, parent_id, osutils.file_iterator(f), entry.file_id,
2840
elif kind in ('directory', 'tree-reference'):
2841
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2842
if kind == 'tree-reference':
2843
tt.set_tree_reference(entry.reference_revision, trans_id)
2845
elif kind == 'symlink':
2846
target = tree.get_symlink_target(path)
2847
return tt.new_symlink(name, parent_id, target, entry.file_id)
2849
raise errors.BadFileKindError(name, kind)
2852
def create_from_tree(tt, trans_id, tree, path, chunks=None,
2853
filter_tree_path=None):
2854
"""Create new file contents according to tree contents.
2856
:param filter_tree_path: the tree path to use to lookup
2857
content filters to apply to the bytes output in the working tree.
2858
This only applies if the working tree supports content filtering.
2860
kind = tree.kind(path)
2861
if kind == 'directory':
2862
tt.create_directory(trans_id)
2863
elif kind == "file":
2865
f = tree.get_file(path)
2866
chunks = osutils.file_iterator(f)
2871
if wt.supports_content_filtering() and filter_tree_path is not None:
2872
filters = wt._content_filter_stack(filter_tree_path)
2873
chunks = filtered_output_bytes(
2875
ContentFilterContext(filter_tree_path, tree))
2876
tt.create_file(chunks, trans_id)
2880
elif kind == "symlink":
2881
tt.create_symlink(tree.get_symlink_target(path), trans_id)
2883
raise AssertionError('Unknown kind %r' % kind)
2886
def create_entry_executability(tt, entry, trans_id):
2887
"""Set the executability of a trans_id according to an inventory entry"""
2888
if entry.kind == "file":
2889
tt.set_executability(entry.executable, trans_id)
2892
def revert(working_tree, target_tree, filenames, backups=False,
2893
pb=None, change_reporter=None):
2894
"""Revert a working tree's contents to those of a target tree."""
2895
pb = ui.ui_factory.nested_progress_bar()
2897
with target_tree.lock_read(), working_tree.get_transform(pb) as tt:
2898
pp = ProgressPhase("Revert phase", 3, pb)
2899
conflicts, merge_modified = _prepare_revert_transform(
2900
working_tree, target_tree, tt, filenames, backups, pp)
2902
change_reporter = delta._ChangeReporter(
2903
unversioned_filter=working_tree.is_ignored)
2904
delta.report_changes(tt.iter_changes(), change_reporter)
2905
for conflict in conflicts:
2906
trace.warning(text_type(conflict))
2909
if working_tree.supports_merge_modified():
2910
working_tree.set_merge_modified(merge_modified)
2916
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2917
backups, pp, basis_tree=None,
2918
merge_modified=None):
2919
with ui.ui_factory.nested_progress_bar() as child_pb:
2920
if merge_modified is None:
2921
merge_modified = working_tree.merge_modified()
2922
merge_modified = _alter_files(working_tree, target_tree, tt,
2923
child_pb, filenames, backups,
2924
merge_modified, basis_tree)
2925
with ui.ui_factory.nested_progress_bar() as child_pb:
2926
raw_conflicts = resolve_conflicts(
2927
tt, child_pb, lambda t, c: conflict_pass(t, c, target_tree))
2928
conflicts = cook_conflicts(raw_conflicts, tt)
2929
return conflicts, merge_modified
2932
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2933
backups, merge_modified, basis_tree=None):
2934
if basis_tree is not None:
2935
basis_tree.lock_read()
2936
# We ask the working_tree for its changes relative to the target, rather
2937
# than the target changes relative to the working tree. Because WT4 has an
2938
# optimizer to compare itself to a target, but no optimizer for the
2940
change_list = working_tree.iter_changes(
2941
target_tree, specific_files=specific_files, pb=pb)
2942
if not target_tree.is_versioned(u''):
2948
for id_num, change in enumerate(change_list):
2949
file_id = change.file_id
2950
target_path, wt_path = change.path
2951
target_versioned, wt_versioned = change.versioned
2952
target_parent, wt_parent = change.parent_id
2953
target_name, wt_name = change.name
2954
target_kind, wt_kind = change.kind
2955
target_executable, wt_executable = change.executable
2956
if skip_root and wt_parent is None:
2958
trans_id = tt.trans_id_file_id(file_id)
2960
if change.changed_content:
2961
keep_content = False
2962
if wt_kind == 'file' and (backups or target_kind is None):
2963
wt_sha1 = working_tree.get_file_sha1(wt_path)
2964
if merge_modified.get(wt_path) != wt_sha1:
2965
# acquire the basis tree lazily to prevent the
2966
# expense of accessing it when it's not needed ?
2967
# (Guessing, RBC, 200702)
2968
if basis_tree is None:
2969
basis_tree = working_tree.basis_tree()
2970
basis_tree.lock_read()
2971
basis_path = find_previous_path(
2972
working_tree, basis_tree, wt_path)
2973
if basis_path is None:
2974
if target_kind is None and not target_versioned:
2977
if wt_sha1 != basis_tree.get_file_sha1(basis_path):
2979
if wt_kind is not None:
2980
if not keep_content:
2981
tt.delete_contents(trans_id)
2982
elif target_kind is not None:
2983
parent_trans_id = tt.trans_id_file_id(wt_parent)
2984
backup_name = tt._available_backup_name(
2985
wt_name, parent_trans_id)
2986
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2987
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2988
if wt_versioned and target_versioned:
2989
tt.unversion_file(trans_id)
2990
tt.version_file(file_id, new_trans_id)
2991
# New contents should have the same unix perms as old
2994
trans_id = new_trans_id
2995
if target_kind in ('directory', 'tree-reference'):
2996
tt.create_directory(trans_id)
2997
if target_kind == 'tree-reference':
2998
revision = target_tree.get_reference_revision(
3000
tt.set_tree_reference(revision, trans_id)
3001
elif target_kind == 'symlink':
3002
tt.create_symlink(target_tree.get_symlink_target(
3003
target_path), trans_id)
3004
elif target_kind == 'file':
3005
deferred_files.append(
3006
(target_path, (trans_id, mode_id, file_id)))
3007
if basis_tree is None:
3008
basis_tree = working_tree.basis_tree()
3009
basis_tree.lock_read()
3010
new_sha1 = target_tree.get_file_sha1(target_path)
3011
basis_path = find_previous_path(target_tree, basis_tree, target_path)
3012
if (basis_path is not None and
3013
new_sha1 == basis_tree.get_file_sha1(basis_path)):
3014
# If the new contents of the file match what is in basis,
3015
# then there is no need to store in merge_modified.
3016
if basis_path in merge_modified:
3017
del merge_modified[basis_path]
3019
merge_modified[target_path] = new_sha1
3021
# preserve the execute bit when backing up
3022
if keep_content and wt_executable == target_executable:
3023
tt.set_executability(target_executable, trans_id)
3024
elif target_kind is not None:
3025
raise AssertionError(target_kind)
3026
if not wt_versioned and target_versioned:
3027
tt.version_file(file_id, trans_id)
3028
if wt_versioned and not target_versioned:
3029
tt.unversion_file(trans_id)
3030
if (target_name is not None
3031
and (wt_name != target_name or wt_parent != target_parent)):
3032
if target_name == '' and target_parent is None:
3033
parent_trans = ROOT_PARENT
3035
parent_trans = tt.trans_id_file_id(target_parent)
3036
if wt_parent is None and wt_versioned:
3037
tt.adjust_root_path(target_name, parent_trans)
3039
tt.adjust_path(target_name, parent_trans, trans_id)
3040
if wt_executable != target_executable and target_kind == "file":
3041
tt.set_executability(target_executable, trans_id)
3042
if working_tree.supports_content_filtering():
3043
for (trans_id, mode_id, file_id), bytes in (
3044
target_tree.iter_files_bytes(deferred_files)):
3045
# We're reverting a tree to the target tree so using the
3046
# target tree to find the file path seems the best choice
3047
# here IMO - Ian C 27/Oct/2009
3048
filter_tree_path = target_tree.id2path(file_id)
3049
filters = working_tree._content_filter_stack(filter_tree_path)
3050
bytes = filtered_output_bytes(
3052
ContentFilterContext(filter_tree_path, working_tree))
3053
tt.create_file(bytes, trans_id, mode_id)
3055
for (trans_id, mode_id, file_id), bytes in target_tree.iter_files_bytes(
3057
tt.create_file(bytes, trans_id, mode_id)
3058
tt.fixup_new_roots()
3060
if basis_tree is not None:
3062
return merge_modified
3065
def resolve_conflicts(tt, pb=None, pass_func=None):
3066
"""Make many conflict-resolution attempts, but die if they fail"""
3067
if pass_func is None:
3068
pass_func = conflict_pass
3069
new_conflicts = set()
3070
with ui.ui_factory.nested_progress_bar() as pb:
3072
pb.update(gettext('Resolution pass'), n + 1, 10)
3073
conflicts = tt.find_conflicts()
3074
if len(conflicts) == 0:
3075
return new_conflicts
3076
new_conflicts.update(pass_func(tt, conflicts))
3077
raise MalformedTransform(conflicts=conflicts)
3080
def conflict_pass(tt, conflicts, path_tree=None):
3081
"""Resolve some classes of conflicts.
3083
:param tt: The transform to resolve conflicts in
3084
:param conflicts: The conflicts to resolve
3085
:param path_tree: A Tree to get supplemental paths from
3087
new_conflicts = set()
3088
for c_type, conflict in ((c[0], c) for c in conflicts):
3089
if c_type == 'duplicate id':
3090
tt.unversion_file(conflict[1])
3091
new_conflicts.add((c_type, 'Unversioned existing file',
3092
conflict[1], conflict[2], ))
3093
elif c_type == 'duplicate':
3094
# files that were renamed take precedence
3095
final_parent = tt.final_parent(conflict[1])
3096
if tt.path_changed(conflict[1]):
3097
existing_file, new_file = conflict[2], conflict[1]
3099
existing_file, new_file = conflict[1], conflict[2]
3100
new_name = tt.final_name(existing_file) + '.moved'
3101
tt.adjust_path(new_name, final_parent, existing_file)
3102
new_conflicts.add((c_type, 'Moved existing file to',
3103
existing_file, new_file))
3104
elif c_type == 'parent loop':
3105
# break the loop by undoing one of the ops that caused the loop
3107
while not tt.path_changed(cur):
3108
cur = tt.final_parent(cur)
3109
new_conflicts.add((c_type, 'Cancelled move', cur,
3110
tt.final_parent(cur),))
3111
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3113
elif c_type == 'missing parent':
3114
trans_id = conflict[1]
3115
if trans_id in tt._removed_contents:
3116
cancel_deletion = True
3117
orphans = tt._get_potential_orphans(trans_id)
3119
cancel_deletion = False
3120
# All children are orphans
3123
tt.new_orphan(o, trans_id)
3124
except OrphaningError:
3125
# Something bad happened so we cancel the directory
3126
# deletion which will leave it in place with a
3127
# conflict. The user can deal with it from there.
3128
# Note that this also catch the case where we don't
3129
# want to create orphans and leave the directory in
3131
cancel_deletion = True
3134
# Cancel the directory deletion
3135
tt.cancel_deletion(trans_id)
3136
new_conflicts.add(('deleting parent', 'Not deleting',
3141
tt.final_name(trans_id)
3143
if path_tree is not None:
3144
file_id = tt.final_file_id(trans_id)
3146
file_id = tt.inactive_file_id(trans_id)
3147
_, entry = next(path_tree.iter_entries_by_dir(
3148
specific_files=[path_tree.id2path(file_id)]))
3149
# special-case the other tree root (move its
3150
# children to current root)
3151
if entry.parent_id is None:
3153
moved = _reparent_transform_children(
3154
tt, trans_id, tt.root)
3156
new_conflicts.add((c_type, 'Moved to root',
3159
parent_trans_id = tt.trans_id_file_id(
3161
tt.adjust_path(entry.name, parent_trans_id,
3164
tt.create_directory(trans_id)
3165
new_conflicts.add((c_type, 'Created directory', trans_id))
3166
elif c_type == 'unversioned parent':
3167
file_id = tt.inactive_file_id(conflict[1])
3168
# special-case the other tree root (move its children instead)
3169
if path_tree and path_tree.path2id('') == file_id:
3170
# This is the root entry, skip it
3172
tt.version_file(file_id, conflict[1])
3173
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3174
elif c_type == 'non-directory parent':
3175
parent_id = conflict[1]
3176
parent_parent = tt.final_parent(parent_id)
3177
parent_name = tt.final_name(parent_id)
3178
parent_file_id = tt.final_file_id(parent_id)
3179
new_parent_id = tt.new_directory(parent_name + '.new',
3180
parent_parent, parent_file_id)
3181
_reparent_transform_children(tt, parent_id, new_parent_id)
3182
if parent_file_id is not None:
3183
tt.unversion_file(parent_id)
3184
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3185
elif c_type == 'versioning no contents':
3186
tt.cancel_versioning(conflict[1])
3187
return new_conflicts
3190
def cook_conflicts(raw_conflicts, tt):
3191
"""Generate a list of cooked conflicts, sorted by file path"""
3192
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3193
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3196
def iter_cook_conflicts(raw_conflicts, tt):
3198
for conflict in raw_conflicts:
3199
c_type = conflict[0]
3200
action = conflict[1]
3201
modified_path = fp.get_path(conflict[2])
3202
modified_id = tt.final_file_id(conflict[2])
3203
if len(conflict) == 3:
3204
yield conflicts.Conflict.factory(
3205
c_type, action=action, path=modified_path, file_id=modified_id)
3208
conflicting_path = fp.get_path(conflict[3])
3209
conflicting_id = tt.final_file_id(conflict[3])
3210
yield conflicts.Conflict.factory(
3211
c_type, action=action, path=modified_path,
3212
file_id=modified_id,
3213
conflict_path=conflicting_path,
3214
conflict_file_id=conflicting_id)
3217
class _FileMover(object):
3218
"""Moves and deletes files for TreeTransform, tracking operations"""
3221
self.past_renames = []
3222
self.pending_deletions = []
3224
def rename(self, from_, to):
3225
"""Rename a file from one path to another."""
3227
os.rename(from_, to)
3228
except OSError as e:
3229
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3230
raise errors.FileExists(to, str(e))
3231
# normal OSError doesn't include filenames so it's hard to see where
3232
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3233
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3234
self.past_renames.append((from_, to))
3236
def pre_delete(self, from_, to):
3237
"""Rename a file out of the way and mark it for deletion.
3239
Unlike os.unlink, this works equally well for files and directories.
3240
:param from_: The current file path
3241
:param to: A temporary path for the file
3243
self.rename(from_, to)
3244
self.pending_deletions.append(to)
3247
"""Reverse all renames that have been performed"""
3248
for from_, to in reversed(self.past_renames):
3250
os.rename(to, from_)
3251
except OSError as e:
3252
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3253
# after rollback, don't reuse _FileMover
3254
self.past_renames = None
3255
self.pending_deletions = None
3257
def apply_deletions(self):
3258
"""Apply all marked deletions"""
3259
for path in self.pending_deletions:
3261
# after apply_deletions, don't reuse _FileMover
3262
self.past_renames = None
3263
self.pending_deletions = None
3266
def link_tree(target_tree, source_tree):
3267
"""Where possible, hard-link files in a tree to those in another tree.
3269
:param target_tree: Tree to change
3270
:param source_tree: Tree to hard-link from
3272
with target_tree.get_transform() as tt:
3273
for change in target_tree.iter_changes(source_tree, include_unchanged=True):
3274
if change.changed_content:
3276
if change.kind != ('file', 'file'):
3278
if change.executable[0] != change.executable[1]:
3280
trans_id = tt.trans_id_tree_path(change.path[1])
3281
tt.delete_contents(trans_id)
3282
tt.create_hardlink(source_tree.abspath(change.path[0]), trans_id)
added
removed
breezy/transform.py
