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.i18n import gettext
49
from .errors import (DuplicateKey, MalformedTransform,
50
ReusingTransform, CantMoveRoot,
51
ImmortalLimbo, NoFinalPath,
53
from .filters import filtered_output_bytes, ContentFilterContext
54
from .mutabletree import MutableTree
55
from .osutils import (
63
from .progress import ProgressPhase
70
ROOT_PARENT = "root-parent"
72
def unique_add(map, key, value):
74
raise DuplicateKey(key=key)
79
class _TransformResults(object):
80
def __init__(self, modified_paths, rename_count):
82
self.modified_paths = modified_paths
83
self.rename_count = rename_count
86
class TreeTransformBase(object):
87
"""The base class for TreeTransform and its kin."""
89
def __init__(self, tree, pb=None,
93
:param tree: The tree that will be transformed, but not necessarily
96
:param case_sensitive: If True, the target of the transform is
97
case sensitive, not just case preserving.
102
# mapping of trans_id -> new basename
104
# mapping of trans_id -> new parent trans_id
105
self._new_parent = {}
106
# mapping of trans_id with new contents -> new file_kind
107
self._new_contents = {}
108
# mapping of trans_id => (sha1 of content, stat_value)
109
self._observed_sha1s = {}
110
# Set of trans_ids whose contents will be removed
111
self._removed_contents = set()
112
# Mapping of trans_id -> new execute-bit value
113
self._new_executability = {}
114
# Mapping of trans_id -> new tree-reference value
115
self._new_reference_revision = {}
116
# Mapping of trans_id -> new file_id
118
# Mapping of old file-id -> trans_id
119
self._non_present_ids = {}
120
# Mapping of new file_id -> trans_id
122
# Set of trans_ids that will be removed
123
self._removed_id = set()
124
# Mapping of path in old tree -> trans_id
125
self._tree_path_ids = {}
126
# Mapping trans_id -> path in old tree
127
self._tree_id_paths = {}
128
# The trans_id that will be used as the tree root
129
root_id = tree.get_root_id()
130
if root_id is not None:
131
self._new_root = self.trans_id_tree_file_id(root_id)
133
self._new_root = None
134
# Indicator of whether the transform has been applied
138
# Whether the target is case sensitive
139
self._case_sensitive_target = case_sensitive
140
# A counter of how many files have been renamed
141
self.rename_count = 0
144
"""Support Context Manager API."""
147
def __exit__(self, exc_type, exc_val, exc_tb):
148
"""Support Context Manager API."""
152
"""Release the working tree lock, if held.
154
This is required if apply has not been invoked, but can be invoked
157
if self._tree is None:
159
for hook in MutableTree.hooks['post_transform']:
160
hook(self._tree, self)
164
def __get_root(self):
165
return self._new_root
167
root = property(__get_root)
169
def _assign_id(self):
170
"""Produce a new tranform id"""
171
new_id = "new-%s" % self._id_number
175
def create_path(self, name, parent):
176
"""Assign a transaction id to a new path"""
177
trans_id = self._assign_id()
178
unique_add(self._new_name, trans_id, name)
179
unique_add(self._new_parent, trans_id, parent)
182
def adjust_path(self, name, parent, trans_id):
183
"""Change the path that is assigned to a transaction id."""
185
raise ValueError("Parent trans-id may not be None")
186
if trans_id == self._new_root:
188
self._new_name[trans_id] = name
189
self._new_parent[trans_id] = parent
191
def adjust_root_path(self, name, parent):
192
"""Emulate moving the root by moving all children, instead.
194
We do this by undoing the association of root's transaction id with the
195
current tree. This allows us to create a new directory with that
196
transaction id. We unversion the root directory and version the
197
physically new directory, and hope someone versions the tree root
200
old_root = self._new_root
201
old_root_file_id = self.final_file_id(old_root)
202
# force moving all children of root
203
for child_id in self.iter_tree_children(old_root):
204
if child_id != parent:
205
self.adjust_path(self.final_name(child_id),
206
self.final_parent(child_id), child_id)
207
file_id = self.final_file_id(child_id)
208
if file_id is not None:
209
self.unversion_file(child_id)
210
self.version_file(file_id, child_id)
212
# the physical root needs a new transaction id
213
self._tree_path_ids.pop("")
214
self._tree_id_paths.pop(old_root)
215
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
216
if parent == old_root:
217
parent = self._new_root
218
self.adjust_path(name, parent, old_root)
219
self.create_directory(old_root)
220
self.version_file(old_root_file_id, old_root)
221
self.unversion_file(self._new_root)
223
def fixup_new_roots(self):
224
"""Reinterpret requests to change the root directory
226
Instead of creating a root directory, or moving an existing directory,
227
all the attributes and children of the new root are applied to the
228
existing root directory.
230
This means that the old root trans-id becomes obsolete, so it is
231
recommended only to invoke this after the root trans-id has become
235
new_roots = [k for k, v in viewitems(self._new_parent)
237
if len(new_roots) < 1:
239
if len(new_roots) != 1:
240
raise ValueError('A tree cannot have two roots!')
241
if self._new_root is None:
242
self._new_root = new_roots[0]
244
old_new_root = new_roots[0]
245
# unversion the new root's directory.
246
if self.final_kind(self._new_root) is None:
247
file_id = self.final_file_id(old_new_root)
249
file_id = self.final_file_id(self._new_root)
250
if old_new_root in self._new_id:
251
self.cancel_versioning(old_new_root)
253
self.unversion_file(old_new_root)
254
# if, at this stage, root still has an old file_id, zap it so we can
255
# stick a new one in.
256
if (self.tree_file_id(self._new_root) is not None and
257
self._new_root not in self._removed_id):
258
self.unversion_file(self._new_root)
259
if file_id is not None:
260
self.version_file(file_id, self._new_root)
262
# Now move children of new root into old root directory.
263
# Ensure all children are registered with the transaction, but don't
264
# use directly-- some tree children have new parents
265
list(self.iter_tree_children(old_new_root))
266
# Move all children of new root into old root directory.
267
for child in self.by_parent().get(old_new_root, []):
268
self.adjust_path(self.final_name(child), self._new_root, child)
270
# Ensure old_new_root has no directory.
271
if old_new_root in self._new_contents:
272
self.cancel_creation(old_new_root)
274
self.delete_contents(old_new_root)
276
# prevent deletion of root directory.
277
if self._new_root in self._removed_contents:
278
self.cancel_deletion(self._new_root)
280
# destroy path info for old_new_root.
281
del self._new_parent[old_new_root]
282
del self._new_name[old_new_root]
284
def trans_id_tree_file_id(self, inventory_id):
285
"""Determine the transaction id of a working tree file.
287
This reflects only files that already exist, not ones that will be
288
added by transactions.
290
if inventory_id is None:
291
raise ValueError('None is not a valid file id')
292
path = self._tree.id2path(inventory_id)
293
return self.trans_id_tree_path(path)
295
def trans_id_file_id(self, file_id):
296
"""Determine or set the transaction id associated with a file ID.
297
A new id is only created for file_ids that were never present. If
298
a transaction has been unversioned, it is deliberately still returned.
299
(this will likely lead to an unversioned parent conflict.)
302
raise ValueError('None is not a valid file id')
303
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
304
return self._r_new_id[file_id]
307
next(self._tree.iter_entries_by_dir([file_id]))
308
except StopIteration:
309
if file_id in self._non_present_ids:
310
return self._non_present_ids[file_id]
312
trans_id = self._assign_id()
313
self._non_present_ids[file_id] = trans_id
316
return self.trans_id_tree_file_id(file_id)
318
def trans_id_tree_path(self, path):
319
"""Determine (and maybe set) the transaction ID for a tree path."""
320
path = self.canonical_path(path)
321
if path not in self._tree_path_ids:
322
self._tree_path_ids[path] = self._assign_id()
323
self._tree_id_paths[self._tree_path_ids[path]] = path
324
return self._tree_path_ids[path]
326
def get_tree_parent(self, trans_id):
327
"""Determine id of the parent in the tree."""
328
path = self._tree_id_paths[trans_id]
331
return self.trans_id_tree_path(os.path.dirname(path))
333
def delete_contents(self, trans_id):
334
"""Schedule the contents of a path entry for deletion"""
335
kind = self.tree_kind(trans_id)
337
self._removed_contents.add(trans_id)
339
def cancel_deletion(self, trans_id):
340
"""Cancel a scheduled deletion"""
341
self._removed_contents.remove(trans_id)
343
def unversion_file(self, trans_id):
344
"""Schedule a path entry to become unversioned"""
345
self._removed_id.add(trans_id)
347
def delete_versioned(self, trans_id):
348
"""Delete and unversion a versioned file"""
349
self.delete_contents(trans_id)
350
self.unversion_file(trans_id)
352
def set_executability(self, executability, trans_id):
353
"""Schedule setting of the 'execute' bit
354
To unschedule, set to None
356
if executability is None:
357
del self._new_executability[trans_id]
359
unique_add(self._new_executability, trans_id, executability)
361
def set_tree_reference(self, revision_id, trans_id):
362
"""Set the reference associated with a directory"""
363
unique_add(self._new_reference_revision, trans_id, revision_id)
365
def version_file(self, file_id, trans_id):
366
"""Schedule a file to become versioned."""
369
unique_add(self._new_id, trans_id, file_id)
370
unique_add(self._r_new_id, file_id, trans_id)
372
def cancel_versioning(self, trans_id):
373
"""Undo a previous versioning of a file"""
374
file_id = self._new_id[trans_id]
375
del self._new_id[trans_id]
376
del self._r_new_id[file_id]
378
def new_paths(self, filesystem_only=False):
379
"""Determine the paths of all new and changed files.
381
:param filesystem_only: if True, only calculate values for files
382
that require renames or execute bit changes.
386
stale_ids = self._needs_rename.difference(self._new_name)
387
stale_ids.difference_update(self._new_parent)
388
stale_ids.difference_update(self._new_contents)
389
stale_ids.difference_update(self._new_id)
390
needs_rename = self._needs_rename.difference(stale_ids)
391
id_sets = (needs_rename, self._new_executability)
393
id_sets = (self._new_name, self._new_parent, self._new_contents,
394
self._new_id, self._new_executability)
395
for id_set in id_sets:
396
new_ids.update(id_set)
397
return sorted(FinalPaths(self).get_paths(new_ids))
399
def _inventory_altered(self):
400
"""Determine which trans_ids need new Inventory entries.
402
An new entry is needed when anything that would be reflected by an
403
inventory entry changes, including file name, file_id, parent file_id,
404
file kind, and the execute bit.
406
Some care is taken to return entries with real changes, not cases
407
where the value is deleted and then restored to its original value,
408
but some actually unchanged values may be returned.
410
:returns: A list of (path, trans_id) for all items requiring an
411
inventory change. Ordered by path.
414
# Find entries whose file_ids are new (or changed).
415
new_file_id = set(t for t in self._new_id
416
if self._new_id[t] != self.tree_file_id(t))
417
for id_set in [self._new_name, self._new_parent, new_file_id,
418
self._new_executability]:
419
changed_ids.update(id_set)
420
# removing implies a kind change
421
changed_kind = set(self._removed_contents)
423
changed_kind.intersection_update(self._new_contents)
424
# Ignore entries that are already known to have changed.
425
changed_kind.difference_update(changed_ids)
426
# to keep only the truly changed ones
427
changed_kind = (t for t in changed_kind
428
if self.tree_kind(t) != self.final_kind(t))
429
# all kind changes will alter the inventory
430
changed_ids.update(changed_kind)
431
# To find entries with changed parent_ids, find parents which existed,
432
# but changed file_id.
433
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
434
# Now add all their children to the set.
435
for parent_trans_id in new_file_id:
436
changed_ids.update(self.iter_tree_children(parent_trans_id))
437
return sorted(FinalPaths(self).get_paths(changed_ids))
439
def final_kind(self, trans_id):
440
"""Determine the final file kind, after any changes applied.
442
:return: None if the file does not exist/has no contents. (It is
443
conceivable that a path would be created without the corresponding
444
contents insertion command)
446
if trans_id in self._new_contents:
447
return self._new_contents[trans_id]
448
elif trans_id in self._removed_contents:
451
return self.tree_kind(trans_id)
453
def tree_file_id(self, trans_id):
454
"""Determine the file id associated with the trans_id in the tree"""
456
path = self._tree_id_paths[trans_id]
458
# the file is a new, unversioned file, or invalid trans_id
460
# the file is old; the old id is still valid
461
if self._new_root == trans_id:
462
return self._tree.get_root_id()
463
return self._tree.path2id(path)
465
def final_file_id(self, trans_id):
466
"""Determine the file id after any changes are applied, or None.
468
None indicates that the file will not be versioned after changes are
472
return self._new_id[trans_id]
474
if trans_id in self._removed_id:
476
return self.tree_file_id(trans_id)
478
def inactive_file_id(self, trans_id):
479
"""Return the inactive file_id associated with a transaction id.
480
That is, the one in the tree or in non_present_ids.
481
The file_id may actually be active, too.
483
file_id = self.tree_file_id(trans_id)
484
if file_id is not None:
486
for key, value in viewitems(self._non_present_ids):
487
if value == trans_id:
490
def final_parent(self, trans_id):
491
"""Determine the parent file_id, after any changes are applied.
493
ROOT_PARENT is returned for the tree root.
496
return self._new_parent[trans_id]
498
return self.get_tree_parent(trans_id)
500
def final_name(self, trans_id):
501
"""Determine the final filename, after all changes are applied."""
503
return self._new_name[trans_id]
506
return os.path.basename(self._tree_id_paths[trans_id])
508
raise NoFinalPath(trans_id, self)
511
"""Return a map of parent: children for known parents.
513
Only new paths and parents of tree files with assigned ids are used.
516
items = list(viewitems(self._new_parent))
517
items.extend((t, self.final_parent(t))
518
for t in list(self._tree_id_paths))
519
for trans_id, parent_id in items:
520
if parent_id not in by_parent:
521
by_parent[parent_id] = set()
522
by_parent[parent_id].add(trans_id)
525
def path_changed(self, trans_id):
526
"""Return True if a trans_id's path has changed."""
527
return (trans_id in self._new_name) or (trans_id in self._new_parent)
529
def new_contents(self, trans_id):
530
return (trans_id in self._new_contents)
532
def find_conflicts(self):
533
"""Find any violations of inventory or filesystem invariants"""
534
if self._done is True:
535
raise ReusingTransform()
537
# ensure all children of all existent parents are known
538
# all children of non-existent parents are known, by definition.
539
self._add_tree_children()
540
by_parent = self.by_parent()
541
conflicts.extend(self._unversioned_parents(by_parent))
542
conflicts.extend(self._parent_loops())
543
conflicts.extend(self._duplicate_entries(by_parent))
544
conflicts.extend(self._duplicate_ids())
545
conflicts.extend(self._parent_type_conflicts(by_parent))
546
conflicts.extend(self._improper_versioning())
547
conflicts.extend(self._executability_conflicts())
548
conflicts.extend(self._overwrite_conflicts())
551
def _check_malformed(self):
552
conflicts = self.find_conflicts()
553
if len(conflicts) != 0:
554
raise MalformedTransform(conflicts=conflicts)
556
def _add_tree_children(self):
557
"""Add all the children of all active parents to the known paths.
559
Active parents are those which gain children, and those which are
560
removed. This is a necessary first step in detecting conflicts.
562
parents = list(self.by_parent())
563
parents.extend([t for t in self._removed_contents if
564
self.tree_kind(t) == 'directory'])
565
for trans_id in self._removed_id:
566
file_id = self.tree_file_id(trans_id)
567
if file_id is not None:
568
if self._tree.stored_kind(file_id) == 'directory':
569
parents.append(trans_id)
570
elif self.tree_kind(trans_id) == 'directory':
571
parents.append(trans_id)
573
for parent_id in parents:
574
# ensure that all children are registered with the transaction
575
list(self.iter_tree_children(parent_id))
577
def _has_named_child(self, name, parent_id, known_children):
578
"""Does a parent already have a name child.
580
:param name: The searched for name.
582
:param parent_id: The parent for which the check is made.
584
:param known_children: The already known children. This should have
585
been recently obtained from `self.by_parent.get(parent_id)`
586
(or will be if None is passed).
588
if known_children is None:
589
known_children = self.by_parent().get(parent_id, [])
590
for child in known_children:
591
if self.final_name(child) == name:
593
parent_path = self._tree_id_paths.get(parent_id, None)
594
if parent_path is None:
595
# No parent... no children
597
child_path = joinpath(parent_path, name)
598
child_id = self._tree_path_ids.get(child_path, None)
600
# Not known by the tree transform yet, check the filesystem
601
return osutils.lexists(self._tree.abspath(child_path))
603
raise AssertionError('child_id is missing: %s, %s, %s'
604
% (name, parent_id, child_id))
606
def _available_backup_name(self, name, target_id):
607
"""Find an available backup name.
609
:param name: The basename of the file.
611
:param target_id: The directory trans_id where the backup should
614
known_children = self.by_parent().get(target_id, [])
615
return osutils.available_backup_name(
617
lambda base: self._has_named_child(
618
base, target_id, known_children))
620
def _parent_loops(self):
621
"""No entry should be its own ancestor"""
623
for trans_id in self._new_parent:
626
while parent_id != ROOT_PARENT:
629
parent_id = self.final_parent(parent_id)
632
if parent_id == trans_id:
633
conflicts.append(('parent loop', trans_id))
634
if parent_id in seen:
638
def _unversioned_parents(self, by_parent):
639
"""If parent directories are versioned, children must be versioned."""
641
for parent_id, children in viewitems(by_parent):
642
if parent_id == ROOT_PARENT:
644
if self.final_file_id(parent_id) is not None:
646
for child_id in children:
647
if self.final_file_id(child_id) is not None:
648
conflicts.append(('unversioned parent', parent_id))
652
def _improper_versioning(self):
653
"""Cannot version a file with no contents, or a bad type.
655
However, existing entries with no contents are okay.
658
for trans_id in self._new_id:
659
kind = self.final_kind(trans_id)
661
conflicts.append(('versioning no contents', trans_id))
663
if not inventory.InventoryEntry.versionable_kind(kind):
664
conflicts.append(('versioning bad kind', trans_id, kind))
667
def _executability_conflicts(self):
668
"""Check for bad executability changes.
670
Only versioned files may have their executability set, because
671
1. only versioned entries can have executability under windows
672
2. only files can be executable. (The execute bit on a directory
673
does not indicate searchability)
676
for trans_id in self._new_executability:
677
if self.final_file_id(trans_id) is None:
678
conflicts.append(('unversioned executability', trans_id))
680
if self.final_kind(trans_id) != "file":
681
conflicts.append(('non-file executability', trans_id))
684
def _overwrite_conflicts(self):
685
"""Check for overwrites (not permitted on Win32)"""
687
for trans_id in self._new_contents:
688
if self.tree_kind(trans_id) is None:
690
if trans_id not in self._removed_contents:
691
conflicts.append(('overwrite', trans_id,
692
self.final_name(trans_id)))
695
def _duplicate_entries(self, by_parent):
696
"""No directory may have two entries with the same name."""
698
if (self._new_name, self._new_parent) == ({}, {}):
700
for children in viewvalues(by_parent):
702
for child_tid in children:
703
name = self.final_name(child_tid)
705
# Keep children only if they still exist in the end
706
if not self._case_sensitive_target:
708
name_ids.append((name, child_tid))
712
for name, trans_id in name_ids:
713
kind = self.final_kind(trans_id)
714
file_id = self.final_file_id(trans_id)
715
if kind is None and file_id is None:
717
if name == last_name:
718
conflicts.append(('duplicate', last_trans_id, trans_id,
721
last_trans_id = trans_id
724
def _duplicate_ids(self):
725
"""Each inventory id may only be used once"""
727
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
729
all_ids = self._tree.all_file_ids()
730
active_tree_ids = all_ids.difference(removed_tree_ids)
731
for trans_id, file_id in viewitems(self._new_id):
732
if file_id in active_tree_ids:
733
old_trans_id = self.trans_id_tree_file_id(file_id)
734
conflicts.append(('duplicate id', old_trans_id, trans_id))
737
def _parent_type_conflicts(self, by_parent):
738
"""Children must have a directory parent"""
740
for parent_id, children in viewitems(by_parent):
741
if parent_id == ROOT_PARENT:
744
for child_id in children:
745
if self.final_kind(child_id) is not None:
750
# There is at least a child, so we need an existing directory to
752
kind = self.final_kind(parent_id)
754
# The directory will be deleted
755
conflicts.append(('missing parent', parent_id))
756
elif kind != "directory":
757
# Meh, we need a *directory* to put something in it
758
conflicts.append(('non-directory parent', parent_id))
761
def _set_executability(self, path, trans_id):
762
"""Set the executability of versioned files """
763
if self._tree._supports_executable():
764
new_executability = self._new_executability[trans_id]
765
abspath = self._tree.abspath(path)
766
current_mode = os.stat(abspath).st_mode
767
if new_executability:
770
to_mode = current_mode | (0o100 & ~umask)
771
# Enable x-bit for others only if they can read it.
772
if current_mode & 0o004:
773
to_mode |= 0o001 & ~umask
774
if current_mode & 0o040:
775
to_mode |= 0o010 & ~umask
777
to_mode = current_mode & ~0o111
778
osutils.chmod_if_possible(abspath, to_mode)
780
def _new_entry(self, name, parent_id, file_id):
781
"""Helper function to create a new filesystem entry."""
782
trans_id = self.create_path(name, parent_id)
783
if file_id is not None:
784
self.version_file(file_id, trans_id)
787
def new_file(self, name, parent_id, contents, file_id=None,
788
executable=None, sha1=None):
789
"""Convenience method to create files.
791
name is the name of the file to create.
792
parent_id is the transaction id of the parent directory of the file.
793
contents is an iterator of bytestrings, which will be used to produce
795
:param file_id: The inventory ID of the file, if it is to be versioned.
796
:param executable: Only valid when a file_id has been supplied.
798
trans_id = self._new_entry(name, parent_id, file_id)
799
# TODO: rather than scheduling a set_executable call,
800
# have create_file create the file with the right mode.
801
self.create_file(contents, trans_id, sha1=sha1)
802
if executable is not None:
803
self.set_executability(executable, trans_id)
806
def new_directory(self, name, parent_id, file_id=None):
807
"""Convenience method to create directories.
809
name is the name of the directory to create.
810
parent_id is the transaction id of the parent directory of the
812
file_id is the inventory ID of the directory, if it is to be versioned.
814
trans_id = self._new_entry(name, parent_id, file_id)
815
self.create_directory(trans_id)
818
def new_symlink(self, name, parent_id, target, file_id=None):
819
"""Convenience method to create symbolic link.
821
name is the name of the symlink to create.
822
parent_id is the transaction id of the parent directory of the symlink.
823
target is a bytestring of the target of the symlink.
824
file_id is the inventory ID of the file, if it is to be versioned.
826
trans_id = self._new_entry(name, parent_id, file_id)
827
self.create_symlink(target, trans_id)
830
def new_orphan(self, trans_id, parent_id):
831
"""Schedule an item to be orphaned.
833
When a directory is about to be removed, its children, if they are not
834
versioned are moved out of the way: they don't have a parent anymore.
836
:param trans_id: The trans_id of the existing item.
837
:param parent_id: The parent trans_id of the item.
839
raise NotImplementedError(self.new_orphan)
841
def _get_potential_orphans(self, dir_id):
842
"""Find the potential orphans in a directory.
844
A directory can't be safely deleted if there are versioned files in it.
845
If all the contained files are unversioned then they can be orphaned.
847
The 'None' return value means that the directory contains at least one
848
versioned file and should not be deleted.
850
:param dir_id: The directory trans id.
852
:return: A list of the orphan trans ids or None if at least one
853
versioned file is present.
856
# Find the potential orphans, stop if one item should be kept
857
for child_tid in self.by_parent()[dir_id]:
858
if child_tid in self._removed_contents:
859
# The child is removed as part of the transform. Since it was
860
# versioned before, it's not an orphan
862
elif self.final_file_id(child_tid) is None:
863
# The child is not versioned
864
orphans.append(child_tid)
866
# We have a versioned file here, searching for orphans is
872
def _affected_ids(self):
873
"""Return the set of transform ids affected by the transform"""
874
trans_ids = set(self._removed_id)
875
trans_ids.update(self._new_id)
876
trans_ids.update(self._removed_contents)
877
trans_ids.update(self._new_contents)
878
trans_ids.update(self._new_executability)
879
trans_ids.update(self._new_name)
880
trans_ids.update(self._new_parent)
883
def _get_file_id_maps(self):
884
"""Return mapping of file_ids to trans_ids in the to and from states"""
885
trans_ids = self._affected_ids()
888
# Build up two dicts: trans_ids associated with file ids in the
889
# FROM state, vs the TO state.
890
for trans_id in trans_ids:
891
from_file_id = self.tree_file_id(trans_id)
892
if from_file_id is not None:
893
from_trans_ids[from_file_id] = trans_id
894
to_file_id = self.final_file_id(trans_id)
895
if to_file_id is not None:
896
to_trans_ids[to_file_id] = trans_id
897
return from_trans_ids, to_trans_ids
899
def _from_file_data(self, from_trans_id, from_versioned, file_id):
900
"""Get data about a file in the from (tree) state
902
Return a (name, parent, kind, executable) tuple
904
from_path = self._tree_id_paths.get(from_trans_id)
906
# get data from working tree if versioned
907
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
908
from_name = from_entry.name
909
from_parent = from_entry.parent_id
912
if from_path is None:
913
# File does not exist in FROM state
917
# File exists, but is not versioned. Have to use path-
919
from_name = os.path.basename(from_path)
920
tree_parent = self.get_tree_parent(from_trans_id)
921
from_parent = self.tree_file_id(tree_parent)
922
if from_path is not None:
923
from_kind, from_executable, from_stats = \
924
self._tree._comparison_data(from_entry, from_path)
927
from_executable = False
928
return from_name, from_parent, from_kind, from_executable
930
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
931
"""Get data about a file in the to (target) state
933
Return a (name, parent, kind, executable) tuple
935
to_name = self.final_name(to_trans_id)
936
to_kind = self.final_kind(to_trans_id)
937
to_parent = self.final_file_id(self.final_parent(to_trans_id))
938
if to_trans_id in self._new_executability:
939
to_executable = self._new_executability[to_trans_id]
940
elif to_trans_id == from_trans_id:
941
to_executable = from_executable
943
to_executable = False
944
return to_name, to_parent, to_kind, to_executable
946
def iter_changes(self):
947
"""Produce output in the same format as Tree.iter_changes.
949
Will produce nonsensical results if invoked while inventory/filesystem
950
conflicts (as reported by TreeTransform.find_conflicts()) are present.
952
This reads the Transform, but only reproduces changes involving a
953
file_id. Files that are not versioned in either of the FROM or TO
954
states are not reflected.
956
final_paths = FinalPaths(self)
957
from_trans_ids, to_trans_ids = self._get_file_id_maps()
959
# Now iterate through all active file_ids
960
for file_id in set(from_trans_ids).union(to_trans_ids):
962
from_trans_id = from_trans_ids.get(file_id)
963
# find file ids, and determine versioning state
964
if from_trans_id is None:
965
from_versioned = False
966
from_trans_id = to_trans_ids[file_id]
968
from_versioned = True
969
to_trans_id = to_trans_ids.get(file_id)
970
if to_trans_id is None:
972
to_trans_id = from_trans_id
976
from_name, from_parent, from_kind, from_executable = \
977
self._from_file_data(from_trans_id, from_versioned, file_id)
979
to_name, to_parent, to_kind, to_executable = \
980
self._to_file_data(to_trans_id, from_trans_id, from_executable)
982
if not from_versioned:
985
from_path = self._tree_id_paths.get(from_trans_id)
989
to_path = final_paths.get_path(to_trans_id)
990
if from_kind != to_kind:
992
elif to_kind in ('file', 'symlink') and (
993
to_trans_id != from_trans_id or
994
to_trans_id in self._new_contents):
996
if (not modified and from_versioned == to_versioned and
997
from_parent==to_parent and from_name == to_name and
998
from_executable == to_executable):
1000
results.append((file_id, (from_path, to_path), modified,
1001
(from_versioned, to_versioned),
1002
(from_parent, to_parent),
1003
(from_name, to_name),
1004
(from_kind, to_kind),
1005
(from_executable, to_executable)))
1006
return iter(sorted(results, key=lambda x:x[1]))
1008
def get_preview_tree(self):
1009
"""Return a tree representing the result of the transform.
1011
The tree is a snapshot, and altering the TreeTransform will invalidate
1014
return _PreviewTree(self)
1016
def commit(self, branch, message, merge_parents=None, strict=False,
1017
timestamp=None, timezone=None, committer=None, authors=None,
1018
revprops=None, revision_id=None):
1019
"""Commit the result of this TreeTransform to a branch.
1021
:param branch: The branch to commit to.
1022
:param message: The message to attach to the commit.
1023
:param merge_parents: Additional parent revision-ids specified by
1025
:param strict: If True, abort the commit if there are unversioned
1027
:param timestamp: if not None, seconds-since-epoch for the time and
1028
date. (May be a float.)
1029
:param timezone: Optional timezone for timestamp, as an offset in
1031
:param committer: Optional committer in email-id format.
1032
(e.g. "J Random Hacker <jrandom@example.com>")
1033
:param authors: Optional list of authors in email-id format.
1034
:param revprops: Optional dictionary of revision properties.
1035
:param revision_id: Optional revision id. (Specifying a revision-id
1036
may reduce performance for some non-native formats.)
1037
:return: The revision_id of the revision committed.
1039
self._check_malformed()
1041
unversioned = set(self._new_contents).difference(set(self._new_id))
1042
for trans_id in unversioned:
1043
if self.final_file_id(trans_id) is None:
1044
raise errors.StrictCommitFailed()
1046
revno, last_rev_id = branch.last_revision_info()
1047
if last_rev_id == _mod_revision.NULL_REVISION:
1048
if merge_parents is not None:
1049
raise ValueError('Cannot supply merge parents for first'
1053
parent_ids = [last_rev_id]
1054
if merge_parents is not None:
1055
parent_ids.extend(merge_parents)
1056
if self._tree.get_revision_id() != last_rev_id:
1057
raise ValueError('TreeTransform not based on branch basis: %s' %
1058
self._tree.get_revision_id())
1059
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1060
builder = branch.get_commit_builder(parent_ids,
1061
timestamp=timestamp,
1063
committer=committer,
1065
revision_id=revision_id)
1066
preview = self.get_preview_tree()
1067
list(builder.record_iter_changes(preview, last_rev_id,
1068
self.iter_changes()))
1069
builder.finish_inventory()
1070
revision_id = builder.commit(message)
1071
branch.set_last_revision_info(revno + 1, revision_id)
1074
def _text_parent(self, trans_id):
1075
file_id = self.tree_file_id(trans_id)
1077
if file_id is None or self._tree.kind(file_id) != 'file':
1079
except errors.NoSuchFile:
1083
def _get_parents_texts(self, trans_id):
1084
"""Get texts for compression parents of this file."""
1085
file_id = self._text_parent(trans_id)
1088
return (self._tree.get_file_text(file_id),)
1090
def _get_parents_lines(self, trans_id):
1091
"""Get lines for compression parents of this file."""
1092
file_id = self._text_parent(trans_id)
1095
return (self._tree.get_file_lines(file_id),)
1097
def serialize(self, serializer):
1098
"""Serialize this TreeTransform.
1100
:param serializer: A Serialiser like pack.ContainerSerializer.
1102
new_name = dict((k, v.encode('utf-8')) for k, v in
1103
viewitems(self._new_name))
1104
new_executability = dict((k, int(v)) for k, v in
1105
viewitems(self._new_executability))
1106
tree_path_ids = dict((k.encode('utf-8'), v)
1107
for k, v in viewitems(self._tree_path_ids))
1109
'_id_number': self._id_number,
1110
'_new_name': new_name,
1111
'_new_parent': self._new_parent,
1112
'_new_executability': new_executability,
1113
'_new_id': self._new_id,
1114
'_tree_path_ids': tree_path_ids,
1115
'_removed_id': list(self._removed_id),
1116
'_removed_contents': list(self._removed_contents),
1117
'_non_present_ids': self._non_present_ids,
1119
yield serializer.bytes_record(bencode.bencode(attribs),
1121
for trans_id, kind in viewitems(self._new_contents):
1123
lines = osutils.chunks_to_lines(
1124
self._read_file_chunks(trans_id))
1125
parents = self._get_parents_lines(trans_id)
1126
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1127
content = ''.join(mpdiff.to_patch())
1128
if kind == 'directory':
1130
if kind == 'symlink':
1131
content = self._read_symlink_target(trans_id)
1132
yield serializer.bytes_record(content, ((trans_id, kind),))
1134
def deserialize(self, records):
1135
"""Deserialize a stored TreeTransform.
1137
:param records: An iterable of (names, content) tuples, as per
1138
pack.ContainerPushParser.
1140
names, content = next(records)
1141
attribs = bencode.bdecode(content)
1142
self._id_number = attribs['_id_number']
1143
self._new_name = dict((k, v.decode('utf-8'))
1144
for k, v in viewitems(attribs['_new_name']))
1145
self._new_parent = attribs['_new_parent']
1146
self._new_executability = dict((k, bool(v))
1147
for k, v in viewitems(attribs['_new_executability']))
1148
self._new_id = attribs['_new_id']
1149
self._r_new_id = dict((v, k) for k, v in viewitems(self._new_id))
1150
self._tree_path_ids = {}
1151
self._tree_id_paths = {}
1152
for bytepath, trans_id in viewitems(attribs['_tree_path_ids']):
1153
path = bytepath.decode('utf-8')
1154
self._tree_path_ids[path] = trans_id
1155
self._tree_id_paths[trans_id] = path
1156
self._removed_id = set(attribs['_removed_id'])
1157
self._removed_contents = set(attribs['_removed_contents'])
1158
self._non_present_ids = attribs['_non_present_ids']
1159
for ((trans_id, kind),), content in records:
1161
mpdiff = multiparent.MultiParent.from_patch(content)
1162
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1163
self.create_file(lines, trans_id)
1164
if kind == 'directory':
1165
self.create_directory(trans_id)
1166
if kind == 'symlink':
1167
self.create_symlink(content.decode('utf-8'), trans_id)
1170
class DiskTreeTransform(TreeTransformBase):
1171
"""Tree transform storing its contents on disk."""
1173
def __init__(self, tree, limbodir, pb=None,
1174
case_sensitive=True):
1176
:param tree: The tree that will be transformed, but not necessarily
1178
:param limbodir: A directory where new files can be stored until
1179
they are installed in their proper places
1181
:param case_sensitive: If True, the target of the transform is
1182
case sensitive, not just case preserving.
1184
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1185
self._limbodir = limbodir
1186
self._deletiondir = None
1187
# A mapping of transform ids to their limbo filename
1188
self._limbo_files = {}
1189
self._possibly_stale_limbo_files = set()
1190
# A mapping of transform ids to a set of the transform ids of children
1191
# that their limbo directory has
1192
self._limbo_children = {}
1193
# Map transform ids to maps of child filename to child transform id
1194
self._limbo_children_names = {}
1195
# List of transform ids that need to be renamed from limbo into place
1196
self._needs_rename = set()
1197
self._creation_mtime = None
1200
"""Release the working tree lock, if held, clean up limbo dir.
1202
This is required if apply has not been invoked, but can be invoked
1205
if self._tree is None:
1208
limbo_paths = list(viewvalues(self._limbo_files))
1209
limbo_paths.extend(self._possibly_stale_limbo_files)
1210
limbo_paths.sort(reverse=True)
1211
for path in limbo_paths:
1214
except OSError as e:
1215
if e.errno != errno.ENOENT:
1217
# XXX: warn? perhaps we just got interrupted at an
1218
# inconvenient moment, but perhaps files are disappearing
1221
delete_any(self._limbodir)
1223
# We don't especially care *why* the dir is immortal.
1224
raise ImmortalLimbo(self._limbodir)
1226
if self._deletiondir is not None:
1227
delete_any(self._deletiondir)
1229
raise errors.ImmortalPendingDeletion(self._deletiondir)
1231
TreeTransformBase.finalize(self)
1233
def _limbo_supports_executable(self):
1234
"""Check if the limbo path supports the executable bit."""
1235
# FIXME: Check actual file system capabilities of limbodir
1236
return osutils.supports_executable()
1238
def _limbo_name(self, trans_id):
1239
"""Generate the limbo name of a file"""
1240
limbo_name = self._limbo_files.get(trans_id)
1241
if limbo_name is None:
1242
limbo_name = self._generate_limbo_path(trans_id)
1243
self._limbo_files[trans_id] = limbo_name
1246
def _generate_limbo_path(self, trans_id):
1247
"""Generate a limbo path using the trans_id as the relative path.
1249
This is suitable as a fallback, and when the transform should not be
1250
sensitive to the path encoding of the limbo directory.
1252
self._needs_rename.add(trans_id)
1253
return pathjoin(self._limbodir, trans_id)
1255
def adjust_path(self, name, parent, trans_id):
1256
previous_parent = self._new_parent.get(trans_id)
1257
previous_name = self._new_name.get(trans_id)
1258
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1259
if (trans_id in self._limbo_files and
1260
trans_id not in self._needs_rename):
1261
self._rename_in_limbo([trans_id])
1262
if previous_parent != parent:
1263
self._limbo_children[previous_parent].remove(trans_id)
1264
if previous_parent != parent or previous_name != name:
1265
del self._limbo_children_names[previous_parent][previous_name]
1267
def _rename_in_limbo(self, trans_ids):
1268
"""Fix limbo names so that the right final path is produced.
1270
This means we outsmarted ourselves-- we tried to avoid renaming
1271
these files later by creating them with their final names in their
1272
final parents. But now the previous name or parent is no longer
1273
suitable, so we have to rename them.
1275
Even for trans_ids that have no new contents, we must remove their
1276
entries from _limbo_files, because they are now stale.
1278
for trans_id in trans_ids:
1279
old_path = self._limbo_files[trans_id]
1280
self._possibly_stale_limbo_files.add(old_path)
1281
del self._limbo_files[trans_id]
1282
if trans_id not in self._new_contents:
1284
new_path = self._limbo_name(trans_id)
1285
os.rename(old_path, new_path)
1286
self._possibly_stale_limbo_files.remove(old_path)
1287
for descendant in self._limbo_descendants(trans_id):
1288
desc_path = self._limbo_files[descendant]
1289
desc_path = new_path + desc_path[len(old_path):]
1290
self._limbo_files[descendant] = desc_path
1292
def _limbo_descendants(self, trans_id):
1293
"""Return the set of trans_ids whose limbo paths descend from this."""
1294
descendants = set(self._limbo_children.get(trans_id, []))
1295
for descendant in list(descendants):
1296
descendants.update(self._limbo_descendants(descendant))
1299
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1300
"""Schedule creation of a new file.
1304
:param contents: an iterator of strings, all of which will be written
1305
to the target destination.
1306
:param trans_id: TreeTransform handle
1307
:param mode_id: If not None, force the mode of the target file to match
1308
the mode of the object referenced by mode_id.
1309
Otherwise, we will try to preserve mode bits of an existing file.
1310
:param sha1: If the sha1 of this content is already known, pass it in.
1311
We can use it to prevent future sha1 computations.
1313
name = self._limbo_name(trans_id)
1314
f = open(name, 'wb')
1316
unique_add(self._new_contents, trans_id, 'file')
1317
f.writelines(contents)
1320
self._set_mtime(name)
1321
self._set_mode(trans_id, mode_id, S_ISREG)
1322
# It is unfortunate we have to use lstat instead of fstat, but we just
1323
# used utime and chmod on the file, so we need the accurate final
1325
if sha1 is not None:
1326
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1328
def _read_file_chunks(self, trans_id):
1329
cur_file = open(self._limbo_name(trans_id), 'rb')
1331
return cur_file.readlines()
1335
def _read_symlink_target(self, trans_id):
1336
return os.readlink(self._limbo_name(trans_id))
1338
def _set_mtime(self, path):
1339
"""All files that are created get the same mtime.
1341
This time is set by the first object to be created.
1343
if self._creation_mtime is None:
1344
self._creation_mtime = time.time()
1345
os.utime(path, (self._creation_mtime, self._creation_mtime))
1347
def create_hardlink(self, path, trans_id):
1348
"""Schedule creation of a hard link"""
1349
name = self._limbo_name(trans_id)
1352
except OSError as e:
1353
if e.errno != errno.EPERM:
1355
raise errors.HardLinkNotSupported(path)
1357
unique_add(self._new_contents, trans_id, 'file')
1359
# Clean up the file, it never got registered so
1360
# TreeTransform.finalize() won't clean it up.
1364
def create_directory(self, trans_id):
1365
"""Schedule creation of a new directory.
1367
See also new_directory.
1369
os.mkdir(self._limbo_name(trans_id))
1370
unique_add(self._new_contents, trans_id, 'directory')
1372
def create_symlink(self, target, trans_id):
1373
"""Schedule creation of a new symbolic link.
1375
target is a bytestring.
1376
See also new_symlink.
1379
os.symlink(target, self._limbo_name(trans_id))
1380
unique_add(self._new_contents, trans_id, 'symlink')
1383
path = FinalPaths(self).get_path(trans_id)
1386
raise UnableCreateSymlink(path=path)
1388
def cancel_creation(self, trans_id):
1389
"""Cancel the creation of new file contents."""
1390
del self._new_contents[trans_id]
1391
if trans_id in self._observed_sha1s:
1392
del self._observed_sha1s[trans_id]
1393
children = self._limbo_children.get(trans_id)
1394
# if this is a limbo directory with children, move them before removing
1396
if children is not None:
1397
self._rename_in_limbo(children)
1398
del self._limbo_children[trans_id]
1399
del self._limbo_children_names[trans_id]
1400
delete_any(self._limbo_name(trans_id))
1402
def new_orphan(self, trans_id, parent_id):
1403
conf = self._tree.get_config_stack()
1404
handle_orphan = conf.get('bzr.transform.orphan_policy')
1405
handle_orphan(self, trans_id, parent_id)
1408
class OrphaningError(errors.BzrError):
1410
# Only bugs could lead to such exception being seen by the user
1411
internal_error = True
1412
_fmt = "Error while orphaning %s in %s directory"
1414
def __init__(self, orphan, parent):
1415
errors.BzrError.__init__(self)
1416
self.orphan = orphan
1417
self.parent = parent
1420
class OrphaningForbidden(OrphaningError):
1422
_fmt = "Policy: %s doesn't allow creating orphans."
1424
def __init__(self, policy):
1425
errors.BzrError.__init__(self)
1426
self.policy = policy
1429
def move_orphan(tt, orphan_id, parent_id):
1430
"""See TreeTransformBase.new_orphan.
1432
This creates a new orphan in the `bzr-orphans` dir at the root of the
1435
:param tt: The TreeTransform orphaning `trans_id`.
1437
:param orphan_id: The trans id that should be orphaned.
1439
:param parent_id: The orphan parent trans id.
1441
# Add the orphan dir if it doesn't exist
1442
orphan_dir_basename = 'bzr-orphans'
1443
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1444
if tt.final_kind(od_id) is None:
1445
tt.create_directory(od_id)
1446
parent_path = tt._tree_id_paths[parent_id]
1447
# Find a name that doesn't exist yet in the orphan dir
1448
actual_name = tt.final_name(orphan_id)
1449
new_name = tt._available_backup_name(actual_name, od_id)
1450
tt.adjust_path(new_name, od_id, orphan_id)
1451
trace.warning('%s has been orphaned in %s'
1452
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1455
def refuse_orphan(tt, orphan_id, parent_id):
1456
"""See TreeTransformBase.new_orphan.
1458
This refuses to create orphan, letting the caller handle the conflict.
1460
raise OrphaningForbidden('never')
1463
orphaning_registry = registry.Registry()
1464
orphaning_registry.register(
1465
'conflict', refuse_orphan,
1466
'Leave orphans in place and create a conflict on the directory.')
1467
orphaning_registry.register(
1468
'move', move_orphan,
1469
'Move orphans into the bzr-orphans directory.')
1470
orphaning_registry._set_default_key('conflict')
1473
opt_transform_orphan = _mod_config.RegistryOption(
1474
'bzr.transform.orphan_policy', orphaning_registry,
1475
help='Policy for orphaned files during transform operations.',
1479
class TreeTransform(DiskTreeTransform):
1480
"""Represent a tree transformation.
1482
This object is designed to support incremental generation of the transform,
1485
However, it gives optimum performance when parent directories are created
1486
before their contents. The transform is then able to put child files
1487
directly in their parent directory, avoiding later renames.
1489
It is easy to produce malformed transforms, but they are generally
1490
harmless. Attempting to apply a malformed transform will cause an
1491
exception to be raised before any modifications are made to the tree.
1493
Many kinds of malformed transforms can be corrected with the
1494
resolve_conflicts function. The remaining ones indicate programming error,
1495
such as trying to create a file with no path.
1497
Two sets of file creation methods are supplied. Convenience methods are:
1502
These are composed of the low-level methods:
1504
* create_file or create_directory or create_symlink
1508
Transform/Transaction ids
1509
-------------------------
1510
trans_ids are temporary ids assigned to all files involved in a transform.
1511
It's possible, even common, that not all files in the Tree have trans_ids.
1513
trans_ids are used because filenames and file_ids are not good enough
1514
identifiers; filenames change, and not all files have file_ids. File-ids
1515
are also associated with trans-ids, so that moving a file moves its
1518
trans_ids are only valid for the TreeTransform that generated them.
1522
Limbo is a temporary directory use to hold new versions of files.
1523
Files are added to limbo by create_file, create_directory, create_symlink,
1524
and their convenience variants (new_*). Files may be removed from limbo
1525
using cancel_creation. Files are renamed from limbo into their final
1526
location as part of TreeTransform.apply
1528
Limbo must be cleaned up, by either calling TreeTransform.apply or
1529
calling TreeTransform.finalize.
1531
Files are placed into limbo inside their parent directories, where
1532
possible. This reduces subsequent renames, and makes operations involving
1533
lots of files faster. This optimization is only possible if the parent
1534
directory is created *before* creating any of its children, so avoid
1535
creating children before parents, where possible.
1539
This temporary directory is used by _FileMover for storing files that are
1540
about to be deleted. In case of rollback, the files will be restored.
1541
FileMover does not delete files until it is sure that a rollback will not
1544
def __init__(self, tree, pb=None):
1545
"""Note: a tree_write lock is taken on the tree.
1547
Use TreeTransform.finalize() to release the lock (can be omitted if
1548
TreeTransform.apply() called).
1550
tree.lock_tree_write()
1553
limbodir = urlutils.local_path_from_url(
1554
tree._transport.abspath('limbo'))
1555
osutils.ensure_empty_directory_exists(
1557
errors.ExistingLimbo)
1558
deletiondir = urlutils.local_path_from_url(
1559
tree._transport.abspath('pending-deletion'))
1560
osutils.ensure_empty_directory_exists(
1562
errors.ExistingPendingDeletion)
1567
# Cache of realpath results, to speed up canonical_path
1568
self._realpaths = {}
1569
# Cache of relpath results, to speed up canonical_path
1571
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1572
tree.case_sensitive)
1573
self._deletiondir = deletiondir
1575
def canonical_path(self, path):
1576
"""Get the canonical tree-relative path"""
1577
# don't follow final symlinks
1578
abs = self._tree.abspath(path)
1579
if abs in self._relpaths:
1580
return self._relpaths[abs]
1581
dirname, basename = os.path.split(abs)
1582
if dirname not in self._realpaths:
1583
self._realpaths[dirname] = os.path.realpath(dirname)
1584
dirname = self._realpaths[dirname]
1585
abs = pathjoin(dirname, basename)
1586
if dirname in self._relpaths:
1587
relpath = pathjoin(self._relpaths[dirname], basename)
1588
relpath = relpath.rstrip('/\\')
1590
relpath = self._tree.relpath(abs)
1591
self._relpaths[abs] = relpath
1594
def tree_kind(self, trans_id):
1595
"""Determine the file kind in the working tree.
1597
:returns: The file kind or None if the file does not exist
1599
path = self._tree_id_paths.get(trans_id)
1603
return file_kind(self._tree.abspath(path))
1604
except errors.NoSuchFile:
1607
def _set_mode(self, trans_id, mode_id, typefunc):
1608
"""Set the mode of new file contents.
1609
The mode_id is the existing file to get the mode from (often the same
1610
as trans_id). The operation is only performed if there's a mode match
1611
according to typefunc.
1616
old_path = self._tree_id_paths[mode_id]
1620
mode = os.stat(self._tree.abspath(old_path)).st_mode
1621
except OSError as e:
1622
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1623
# Either old_path doesn't exist, or the parent of the
1624
# target is not a directory (but will be one eventually)
1625
# Either way, we know it doesn't exist *right now*
1626
# See also bug #248448
1631
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1633
def iter_tree_children(self, parent_id):
1634
"""Iterate through the entry's tree children, if any"""
1636
path = self._tree_id_paths[parent_id]
1640
children = os.listdir(self._tree.abspath(path))
1641
except OSError as e:
1642
if not (osutils._is_error_enotdir(e)
1643
or e.errno in (errno.ENOENT, errno.ESRCH)):
1647
for child in children:
1648
childpath = joinpath(path, child)
1649
if self._tree.is_control_filename(childpath):
1651
yield self.trans_id_tree_path(childpath)
1653
def _generate_limbo_path(self, trans_id):
1654
"""Generate a limbo path using the final path if possible.
1656
This optimizes the performance of applying the tree transform by
1657
avoiding renames. These renames can be avoided only when the parent
1658
directory is already scheduled for creation.
1660
If the final path cannot be used, falls back to using the trans_id as
1663
parent = self._new_parent.get(trans_id)
1664
# if the parent directory is already in limbo (e.g. when building a
1665
# tree), choose a limbo name inside the parent, to reduce further
1667
use_direct_path = False
1668
if self._new_contents.get(parent) == 'directory':
1669
filename = self._new_name.get(trans_id)
1670
if filename is not None:
1671
if parent not in self._limbo_children:
1672
self._limbo_children[parent] = set()
1673
self._limbo_children_names[parent] = {}
1674
use_direct_path = True
1675
# the direct path can only be used if no other file has
1676
# already taken this pathname, i.e. if the name is unused, or
1677
# if it is already associated with this trans_id.
1678
elif self._case_sensitive_target:
1679
if (self._limbo_children_names[parent].get(filename)
1680
in (trans_id, None)):
1681
use_direct_path = True
1683
for l_filename, l_trans_id in viewitems(
1684
self._limbo_children_names[parent]):
1685
if l_trans_id == trans_id:
1687
if l_filename.lower() == filename.lower():
1690
use_direct_path = True
1692
if not use_direct_path:
1693
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1695
limbo_name = pathjoin(self._limbo_files[parent], filename)
1696
self._limbo_children[parent].add(trans_id)
1697
self._limbo_children_names[parent][filename] = trans_id
1701
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1702
"""Apply all changes to the inventory and filesystem.
1704
If filesystem or inventory conflicts are present, MalformedTransform
1707
If apply succeeds, finalize is not necessary.
1709
:param no_conflicts: if True, the caller guarantees there are no
1710
conflicts, so no check is made.
1711
:param precomputed_delta: An inventory delta to use instead of
1713
:param _mover: Supply an alternate FileMover, for testing
1715
for hook in MutableTree.hooks['pre_transform']:
1716
hook(self._tree, self)
1717
if not no_conflicts:
1718
self._check_malformed()
1719
child_pb = ui.ui_factory.nested_progress_bar()
1721
if precomputed_delta is None:
1722
child_pb.update(gettext('Apply phase'), 0, 2)
1723
inventory_delta = self._generate_inventory_delta()
1726
inventory_delta = precomputed_delta
1729
mover = _FileMover()
1733
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1734
self._apply_removals(mover)
1735
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1736
modified_paths = self._apply_insertions(mover)
1741
mover.apply_deletions()
1744
if self.final_file_id(self.root) is None:
1745
inventory_delta = [e for e in inventory_delta if e[0] != '']
1746
self._tree.apply_inventory_delta(inventory_delta)
1747
self._apply_observed_sha1s()
1750
return _TransformResults(modified_paths, self.rename_count)
1752
def _generate_inventory_delta(self):
1753
"""Generate an inventory delta for the current transform."""
1754
inventory_delta = []
1755
child_pb = ui.ui_factory.nested_progress_bar()
1756
new_paths = self._inventory_altered()
1757
total_entries = len(new_paths) + len(self._removed_id)
1759
for num, trans_id in enumerate(self._removed_id):
1761
child_pb.update(gettext('removing file'), num, total_entries)
1762
if trans_id == self._new_root:
1763
file_id = self._tree.get_root_id()
1765
file_id = self.tree_file_id(trans_id)
1766
# File-id isn't really being deleted, just moved
1767
if file_id in self._r_new_id:
1769
path = self._tree_id_paths[trans_id]
1770
inventory_delta.append((path, None, file_id, None))
1771
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1773
entries = self._tree.iter_entries_by_dir(
1774
viewvalues(new_path_file_ids))
1775
old_paths = dict((e.file_id, p) for p, e in entries)
1777
for num, (path, trans_id) in enumerate(new_paths):
1779
child_pb.update(gettext('adding file'),
1780
num + len(self._removed_id), total_entries)
1781
file_id = new_path_file_ids[trans_id]
1785
kind = self.final_kind(trans_id)
1787
kind = self._tree.stored_kind(file_id)
1788
parent_trans_id = self.final_parent(trans_id)
1789
parent_file_id = new_path_file_ids.get(parent_trans_id)
1790
if parent_file_id is None:
1791
parent_file_id = self.final_file_id(parent_trans_id)
1792
if trans_id in self._new_reference_revision:
1793
new_entry = inventory.TreeReference(
1795
self._new_name[trans_id],
1796
self.final_file_id(self._new_parent[trans_id]),
1797
None, self._new_reference_revision[trans_id])
1799
new_entry = inventory.make_entry(kind,
1800
self.final_name(trans_id),
1801
parent_file_id, file_id)
1802
old_path = old_paths.get(new_entry.file_id)
1803
new_executability = self._new_executability.get(trans_id)
1804
if new_executability is not None:
1805
new_entry.executable = new_executability
1806
inventory_delta.append(
1807
(old_path, path, new_entry.file_id, new_entry))
1810
return inventory_delta
1812
def _apply_removals(self, mover):
1813
"""Perform tree operations that remove directory/inventory names.
1815
That is, delete files that are to be deleted, and put any files that
1816
need renaming into limbo. This must be done in strict child-to-parent
1819
If inventory_delta is None, no inventory delta generation is performed.
1821
tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
1822
child_pb = ui.ui_factory.nested_progress_bar()
1824
for num, (path, trans_id) in enumerate(tree_paths):
1825
# do not attempt to move root into a subdirectory of itself.
1828
child_pb.update(gettext('removing file'), num, len(tree_paths))
1829
full_path = self._tree.abspath(path)
1830
if trans_id in self._removed_contents:
1831
delete_path = os.path.join(self._deletiondir, trans_id)
1832
mover.pre_delete(full_path, delete_path)
1833
elif (trans_id in self._new_name
1834
or trans_id in self._new_parent):
1836
mover.rename(full_path, self._limbo_name(trans_id))
1837
except errors.TransformRenameFailed as e:
1838
if e.errno != errno.ENOENT:
1841
self.rename_count += 1
1845
def _apply_insertions(self, mover):
1846
"""Perform tree operations that insert directory/inventory names.
1848
That is, create any files that need to be created, and restore from
1849
limbo any files that needed renaming. This must be done in strict
1850
parent-to-child order.
1852
If inventory_delta is None, no inventory delta is calculated, and
1853
no list of modified paths is returned.
1855
new_paths = self.new_paths(filesystem_only=True)
1857
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1859
child_pb = ui.ui_factory.nested_progress_bar()
1861
for num, (path, trans_id) in enumerate(new_paths):
1863
child_pb.update(gettext('adding file'), num, len(new_paths))
1864
full_path = self._tree.abspath(path)
1865
if trans_id in self._needs_rename:
1867
mover.rename(self._limbo_name(trans_id), full_path)
1868
except errors.TransformRenameFailed as e:
1869
# We may be renaming a dangling inventory id
1870
if e.errno != errno.ENOENT:
1873
self.rename_count += 1
1874
# TODO: if trans_id in self._observed_sha1s, we should
1875
# re-stat the final target, since ctime will be
1876
# updated by the change.
1877
if (trans_id in self._new_contents or
1878
self.path_changed(trans_id)):
1879
if trans_id in self._new_contents:
1880
modified_paths.append(full_path)
1881
if trans_id in self._new_executability:
1882
self._set_executability(path, trans_id)
1883
if trans_id in self._observed_sha1s:
1884
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1885
st = osutils.lstat(full_path)
1886
self._observed_sha1s[trans_id] = (o_sha1, st)
1889
for path, trans_id in new_paths:
1890
# new_paths includes stuff like workingtree conflicts. Only the
1891
# stuff in new_contents actually comes from limbo.
1892
if trans_id in self._limbo_files:
1893
del self._limbo_files[trans_id]
1894
self._new_contents.clear()
1895
return modified_paths
1897
def _apply_observed_sha1s(self):
1898
"""After we have finished renaming everything, update observed sha1s
1900
This has to be done after self._tree.apply_inventory_delta, otherwise
1901
it doesn't know anything about the files we are updating. Also, we want
1902
to do this as late as possible, so that most entries end up cached.
1904
# TODO: this doesn't update the stat information for directories. So
1905
# the first 'bzr status' will still need to rewrite
1906
# .bzr/checkout/dirstate. However, we at least don't need to
1907
# re-read all of the files.
1908
# TODO: If the operation took a while, we could do a time.sleep(3) here
1909
# to allow the clock to tick over and ensure we won't have any
1910
# problems. (we could observe start time, and finish time, and if
1911
# it is less than eg 10% overhead, add a sleep call.)
1912
paths = FinalPaths(self)
1913
for trans_id, observed in viewitems(self._observed_sha1s):
1914
path = paths.get_path(trans_id)
1915
# We could get the file_id, but dirstate prefers to use the path
1916
# anyway, and it is 'cheaper' to determine.
1917
# file_id = self._new_id[trans_id]
1918
self._tree._observed_sha1(None, path, observed)
1921
class TransformPreview(DiskTreeTransform):
1922
"""A TreeTransform for generating preview trees.
1924
Unlike TreeTransform, this version works when the input tree is a
1925
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1926
unversioned files in the input tree.
1929
def __init__(self, tree, pb=None, case_sensitive=True):
1931
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1932
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1934
def canonical_path(self, path):
1937
def tree_kind(self, trans_id):
1938
path = self._tree_id_paths.get(trans_id)
1941
kind = self._tree.path_content_summary(path)[0]
1942
if kind == 'missing':
1946
def _set_mode(self, trans_id, mode_id, typefunc):
1947
"""Set the mode of new file contents.
1948
The mode_id is the existing file to get the mode from (often the same
1949
as trans_id). The operation is only performed if there's a mode match
1950
according to typefunc.
1952
# is it ok to ignore this? probably
1955
def iter_tree_children(self, parent_id):
1956
"""Iterate through the entry's tree children, if any"""
1958
path = self._tree_id_paths[parent_id]
1961
file_id = self.tree_file_id(parent_id)
1964
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1965
children = getattr(entry, 'children', {})
1966
for child in children:
1967
childpath = joinpath(path, child)
1968
yield self.trans_id_tree_path(childpath)
1970
def new_orphan(self, trans_id, parent_id):
1971
raise NotImplementedError(self.new_orphan)
1974
class _PreviewTree(tree.InventoryTree):
1975
"""Partial implementation of Tree to support show_diff_trees"""
1977
def __init__(self, transform):
1978
self._transform = transform
1979
self._final_paths = FinalPaths(transform)
1980
self.__by_parent = None
1981
self._parent_ids = []
1982
self._all_children_cache = {}
1983
self._path2trans_id_cache = {}
1984
self._final_name_cache = {}
1985
self._iter_changes_cache = dict((c[0], c) for c in
1986
self._transform.iter_changes())
1988
def _content_change(self, file_id):
1989
"""Return True if the content of this file changed"""
1990
changes = self._iter_changes_cache.get(file_id)
1991
# changes[2] is true if the file content changed. See
1992
# InterTree.iter_changes.
1993
return (changes is not None and changes[2])
1995
def _get_repository(self):
1996
repo = getattr(self._transform._tree, '_repository', None)
1998
repo = self._transform._tree.branch.repository
2001
def _iter_parent_trees(self):
2002
for revision_id in self.get_parent_ids():
2004
yield self.revision_tree(revision_id)
2005
except errors.NoSuchRevisionInTree:
2006
yield self._get_repository().revision_tree(revision_id)
2008
def _get_file_revision(self, file_id, vf, tree_revision):
2009
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2010
self._iter_parent_trees()]
2011
vf.add_lines((file_id, tree_revision), parent_keys,
2012
self.get_file_lines(file_id))
2013
repo = self._get_repository()
2014
base_vf = repo.texts
2015
if base_vf not in vf.fallback_versionedfiles:
2016
vf.fallback_versionedfiles.append(base_vf)
2017
return tree_revision
2019
def _stat_limbo_file(self, file_id=None, trans_id=None):
2020
if trans_id is None:
2021
trans_id = self._transform.trans_id_file_id(file_id)
2022
name = self._transform._limbo_name(trans_id)
2023
return os.lstat(name)
2026
def _by_parent(self):
2027
if self.__by_parent is None:
2028
self.__by_parent = self._transform.by_parent()
2029
return self.__by_parent
2031
def _comparison_data(self, entry, path):
2032
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2033
if kind == 'missing':
2037
file_id = self._transform.final_file_id(self._path2trans_id(path))
2038
executable = self.is_executable(file_id, path)
2039
return kind, executable, None
2041
def is_locked(self):
2044
def lock_read(self):
2045
# Perhaps in theory, this should lock the TreeTransform?
2052
def root_inventory(self):
2053
"""This Tree does not use inventory as its backing data."""
2054
raise NotImplementedError(_PreviewTree.root_inventory)
2056
def get_root_id(self):
2057
return self._transform.final_file_id(self._transform.root)
2059
def all_file_ids(self):
2060
tree_ids = set(self._transform._tree.all_file_ids())
2061
tree_ids.difference_update(self._transform.tree_file_id(t)
2062
for t in self._transform._removed_id)
2063
tree_ids.update(viewvalues(self._transform._new_id))
2067
return iter(self.all_file_ids())
2069
def _has_id(self, file_id, fallback_check):
2070
if file_id in self._transform._r_new_id:
2072
elif file_id in {self._transform.tree_file_id(trans_id) for
2073
trans_id in self._transform._removed_id}:
2076
return fallback_check(file_id)
2078
def has_id(self, file_id):
2079
return self._has_id(file_id, self._transform._tree.has_id)
2081
def has_or_had_id(self, file_id):
2082
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2084
def _path2trans_id(self, path):
2085
# We must not use None here, because that is a valid value to store.
2086
trans_id = self._path2trans_id_cache.get(path, object)
2087
if trans_id is not object:
2089
segments = splitpath(path)
2090
cur_parent = self._transform.root
2091
for cur_segment in segments:
2092
for child in self._all_children(cur_parent):
2093
final_name = self._final_name_cache.get(child)
2094
if final_name is None:
2095
final_name = self._transform.final_name(child)
2096
self._final_name_cache[child] = final_name
2097
if final_name == cur_segment:
2101
self._path2trans_id_cache[path] = None
2103
self._path2trans_id_cache[path] = cur_parent
2106
def path2id(self, path):
2107
if isinstance(path, list):
2110
path = osutils.pathjoin(*path)
2111
return self._transform.final_file_id(self._path2trans_id(path))
2113
def id2path(self, file_id):
2114
trans_id = self._transform.trans_id_file_id(file_id)
2116
return self._final_paths._determine_path(trans_id)
2118
raise errors.NoSuchId(self, file_id)
2120
def _all_children(self, trans_id):
2121
children = self._all_children_cache.get(trans_id)
2122
if children is not None:
2124
children = set(self._transform.iter_tree_children(trans_id))
2125
# children in the _new_parent set are provided by _by_parent.
2126
children.difference_update(self._transform._new_parent)
2127
children.update(self._by_parent.get(trans_id, []))
2128
self._all_children_cache[trans_id] = children
2131
def iter_children(self, file_id):
2132
trans_id = self._transform.trans_id_file_id(file_id)
2133
for child_trans_id in self._all_children(trans_id):
2134
yield self._transform.final_file_id(child_trans_id)
2137
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2138
in self._transform._tree.extras())
2139
possible_extras.update(self._transform._new_contents)
2140
possible_extras.update(self._transform._removed_id)
2141
for trans_id in possible_extras:
2142
if self._transform.final_file_id(trans_id) is None:
2143
yield self._final_paths._determine_path(trans_id)
2145
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2146
yield_parents=False):
2147
for trans_id, parent_file_id in ordered_entries:
2148
file_id = self._transform.final_file_id(trans_id)
2151
if (specific_file_ids is not None
2152
and file_id not in specific_file_ids):
2154
kind = self._transform.final_kind(trans_id)
2156
kind = self._transform._tree.stored_kind(file_id)
2157
new_entry = inventory.make_entry(
2159
self._transform.final_name(trans_id),
2160
parent_file_id, file_id)
2161
yield new_entry, trans_id
2163
def _list_files_by_dir(self):
2164
todo = [ROOT_PARENT]
2166
while len(todo) > 0:
2168
parent_file_id = self._transform.final_file_id(parent)
2169
children = list(self._all_children(parent))
2170
paths = dict(zip(children, self._final_paths.get_paths(children)))
2171
children.sort(key=paths.get)
2172
todo.extend(reversed(children))
2173
for trans_id in children:
2174
ordered_ids.append((trans_id, parent_file_id))
2177
def iter_child_entries(self, file_id, path=None):
2178
self.id2path(file_id)
2179
trans_id = self._transform.trans_id_file_id(file_id)
2180
todo = [(child_trans_id, trans_id) for child_trans_id in
2181
self._all_children(trans_id)]
2182
for entry, trans_id in self._make_inv_entries(todo):
2185
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2186
# This may not be a maximally efficient implementation, but it is
2187
# reasonably straightforward. An implementation that grafts the
2188
# TreeTransform changes onto the tree's iter_entries_by_dir results
2189
# might be more efficient, but requires tricky inferences about stack
2191
ordered_ids = self._list_files_by_dir()
2192
for entry, trans_id in self._make_inv_entries(ordered_ids,
2193
specific_file_ids, yield_parents=yield_parents):
2194
yield unicode(self._final_paths.get_path(trans_id)), entry
2196
def _iter_entries_for_dir(self, dir_path):
2197
"""Return path, entry for items in a directory without recursing down."""
2198
dir_file_id = self.path2id(dir_path)
2200
for file_id in self.iter_children(dir_file_id):
2201
trans_id = self._transform.trans_id_file_id(file_id)
2202
ordered_ids.append((trans_id, file_id))
2203
for entry, trans_id in self._make_inv_entries(ordered_ids):
2204
yield unicode(self._final_paths.get_path(trans_id)), entry
2206
def list_files(self, include_root=False, from_dir=None, recursive=True):
2207
"""See WorkingTree.list_files."""
2208
# XXX This should behave like WorkingTree.list_files, but is really
2209
# more like RevisionTree.list_files.
2213
prefix = from_dir + '/'
2214
entries = self.iter_entries_by_dir()
2215
for path, entry in entries:
2216
if entry.name == '' and not include_root:
2219
if not path.startswith(prefix):
2221
path = path[len(prefix):]
2222
yield path, 'V', entry.kind, entry.file_id, entry
2224
if from_dir is None and include_root is True:
2225
root_entry = inventory.make_entry('directory', '',
2226
ROOT_PARENT, self.get_root_id())
2227
yield '', 'V', 'directory', root_entry.file_id, root_entry
2228
entries = self._iter_entries_for_dir(from_dir or '')
2229
for path, entry in entries:
2230
yield path, 'V', entry.kind, entry.file_id, entry
2232
def kind(self, file_id):
2233
trans_id = self._transform.trans_id_file_id(file_id)
2234
return self._transform.final_kind(trans_id)
2236
def stored_kind(self, file_id):
2237
trans_id = self._transform.trans_id_file_id(file_id)
2239
return self._transform._new_contents[trans_id]
2241
return self._transform._tree.stored_kind(file_id)
2243
def get_file_mtime(self, file_id, path=None):
2244
"""See Tree.get_file_mtime"""
2245
if not self._content_change(file_id):
2246
return self._transform._tree.get_file_mtime(file_id)
2247
return self._stat_limbo_file(file_id).st_mtime
2249
def _file_size(self, entry, stat_value):
2250
return self.get_file_size(entry.file_id)
2252
def get_file_size(self, file_id):
2253
"""See Tree.get_file_size"""
2254
trans_id = self._transform.trans_id_file_id(file_id)
2255
kind = self._transform.final_kind(trans_id)
2258
if trans_id in self._transform._new_contents:
2259
return self._stat_limbo_file(trans_id=trans_id).st_size
2260
if self.kind(file_id) == 'file':
2261
return self._transform._tree.get_file_size(file_id)
2265
def get_file_verifier(self, file_id, path=None, stat_value=None):
2266
trans_id = self._transform.trans_id_file_id(file_id)
2267
kind = self._transform._new_contents.get(trans_id)
2269
return self._transform._tree.get_file_verifier(file_id)
2271
fileobj = self.get_file(file_id)
2273
return ("SHA1", sha_file(fileobj))
2277
def get_file_sha1(self, file_id, path=None, stat_value=None):
2278
trans_id = self._transform.trans_id_file_id(file_id)
2279
kind = self._transform._new_contents.get(trans_id)
2281
return self._transform._tree.get_file_sha1(file_id)
2283
fileobj = self.get_file(file_id)
2285
return sha_file(fileobj)
2289
def is_executable(self, file_id, path=None):
2292
trans_id = self._transform.trans_id_file_id(file_id)
2294
return self._transform._new_executability[trans_id]
2297
return self._transform._tree.is_executable(file_id, path)
2298
except OSError as e:
2299
if e.errno == errno.ENOENT:
2302
except errors.NoSuchId:
2305
def has_filename(self, path):
2306
trans_id = self._path2trans_id(path)
2307
if trans_id in self._transform._new_contents:
2309
elif trans_id in self._transform._removed_contents:
2312
return self._transform._tree.has_filename(path)
2314
def path_content_summary(self, path):
2315
trans_id = self._path2trans_id(path)
2316
tt = self._transform
2317
tree_path = tt._tree_id_paths.get(trans_id)
2318
kind = tt._new_contents.get(trans_id)
2320
if tree_path is None or trans_id in tt._removed_contents:
2321
return 'missing', None, None, None
2322
summary = tt._tree.path_content_summary(tree_path)
2323
kind, size, executable, link_or_sha1 = summary
2326
limbo_name = tt._limbo_name(trans_id)
2327
if trans_id in tt._new_reference_revision:
2328
kind = 'tree-reference'
2330
statval = os.lstat(limbo_name)
2331
size = statval.st_size
2332
if not tt._limbo_supports_executable():
2335
executable = statval.st_mode & S_IEXEC
2339
if kind == 'symlink':
2340
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2341
executable = tt._new_executability.get(trans_id, executable)
2342
return kind, size, executable, link_or_sha1
2344
def iter_changes(self, from_tree, include_unchanged=False,
2345
specific_files=None, pb=None, extra_trees=None,
2346
require_versioned=True, want_unversioned=False):
2347
"""See InterTree.iter_changes.
2349
This has a fast path that is only used when the from_tree matches
2350
the transform tree, and no fancy options are supplied.
2352
if (from_tree is not self._transform._tree or include_unchanged or
2353
specific_files or want_unversioned):
2354
return tree.InterTree(from_tree, self).iter_changes(
2355
include_unchanged=include_unchanged,
2356
specific_files=specific_files,
2358
extra_trees=extra_trees,
2359
require_versioned=require_versioned,
2360
want_unversioned=want_unversioned)
2361
if want_unversioned:
2362
raise ValueError('want_unversioned is not supported')
2363
return self._transform.iter_changes()
2365
def get_file(self, file_id, path=None):
2366
"""See Tree.get_file"""
2367
if not self._content_change(file_id):
2368
return self._transform._tree.get_file(file_id, path)
2369
trans_id = self._transform.trans_id_file_id(file_id)
2370
name = self._transform._limbo_name(trans_id)
2371
return open(name, 'rb')
2373
def get_file_with_stat(self, file_id, path=None):
2374
return self.get_file(file_id, path), None
2376
def annotate_iter(self, file_id,
2377
default_revision=_mod_revision.CURRENT_REVISION):
2378
changes = self._iter_changes_cache.get(file_id)
2382
changed_content, versioned, kind = (changes[2], changes[3],
2386
get_old = (kind[0] == 'file' and versioned[0])
2388
old_annotation = self._transform._tree.annotate_iter(file_id,
2389
default_revision=default_revision)
2393
return old_annotation
2394
if not changed_content:
2395
return old_annotation
2396
# TODO: This is doing something similar to what WT.annotate_iter is
2397
# doing, however it fails slightly because it doesn't know what
2398
# the *other* revision_id is, so it doesn't know how to give the
2399
# other as the origin for some lines, they all get
2400
# 'default_revision'
2401
# It would be nice to be able to use the new Annotator based
2402
# approach, as well.
2403
return annotate.reannotate([old_annotation],
2404
self.get_file(file_id).readlines(),
2407
def get_symlink_target(self, file_id, path=None):
2408
"""See Tree.get_symlink_target"""
2409
if not self._content_change(file_id):
2410
return self._transform._tree.get_symlink_target(file_id)
2411
trans_id = self._transform.trans_id_file_id(file_id)
2412
name = self._transform._limbo_name(trans_id)
2413
return osutils.readlink(name)
2415
def walkdirs(self, prefix=''):
2416
pending = [self._transform.root]
2417
while len(pending) > 0:
2418
parent_id = pending.pop()
2421
prefix = prefix.rstrip('/')
2422
parent_path = self._final_paths.get_path(parent_id)
2423
parent_file_id = self._transform.final_file_id(parent_id)
2424
for child_id in self._all_children(parent_id):
2425
path_from_root = self._final_paths.get_path(child_id)
2426
basename = self._transform.final_name(child_id)
2427
file_id = self._transform.final_file_id(child_id)
2428
kind = self._transform.final_kind(child_id)
2429
if kind is not None:
2430
versioned_kind = kind
2433
versioned_kind = self._transform._tree.stored_kind(file_id)
2434
if versioned_kind == 'directory':
2435
subdirs.append(child_id)
2436
children.append((path_from_root, basename, kind, None,
2437
file_id, versioned_kind))
2439
if parent_path.startswith(prefix):
2440
yield (parent_path, parent_file_id), children
2441
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2444
def get_parent_ids(self):
2445
return self._parent_ids
2447
def set_parent_ids(self, parent_ids):
2448
self._parent_ids = parent_ids
2450
def get_revision_tree(self, revision_id):
2451
return self._transform._tree.get_revision_tree(revision_id)
2454
def joinpath(parent, child):
2455
"""Join tree-relative paths, handling the tree root specially"""
2456
if parent is None or parent == "":
2459
return pathjoin(parent, child)
2462
class FinalPaths(object):
2463
"""Make path calculation cheap by memoizing paths.
2465
The underlying tree must not be manipulated between calls, or else
2466
the results will likely be incorrect.
2468
def __init__(self, transform):
2469
object.__init__(self)
2470
self._known_paths = {}
2471
self.transform = transform
2473
def _determine_path(self, trans_id):
2474
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2476
name = self.transform.final_name(trans_id)
2477
parent_id = self.transform.final_parent(trans_id)
2478
if parent_id == self.transform.root:
2481
return pathjoin(self.get_path(parent_id), name)
2483
def get_path(self, trans_id):
2484
"""Find the final path associated with a trans_id"""
2485
if trans_id not in self._known_paths:
2486
self._known_paths[trans_id] = self._determine_path(trans_id)
2487
return self._known_paths[trans_id]
2489
def get_paths(self, trans_ids):
2490
return [(self.get_path(t), t) for t in trans_ids]
2494
def topology_sorted_ids(tree):
2495
"""Determine the topological order of the ids in a tree"""
2496
file_ids = list(tree)
2497
file_ids.sort(key=tree.id2path)
2501
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2502
delta_from_tree=False):
2503
"""Create working tree for a branch, using a TreeTransform.
2505
This function should be used on empty trees, having a tree root at most.
2506
(see merge and revert functionality for working with existing trees)
2508
Existing files are handled like so:
2510
- Existing bzrdirs take precedence over creating new items. They are
2511
created as '%s.diverted' % name.
2512
- Otherwise, if the content on disk matches the content we are building,
2513
it is silently replaced.
2514
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2516
:param tree: The tree to convert wt into a copy of
2517
:param wt: The working tree that files will be placed into
2518
:param accelerator_tree: A tree which can be used for retrieving file
2519
contents more quickly than tree itself, i.e. a workingtree. tree
2520
will be used for cases where accelerator_tree's content is different.
2521
:param hardlink: If true, hard-link files to accelerator_tree, where
2522
possible. accelerator_tree must implement abspath, i.e. be a
2524
:param delta_from_tree: If true, build_tree may use the input Tree to
2525
generate the inventory delta.
2527
wt.lock_tree_write()
2531
if accelerator_tree is not None:
2532
accelerator_tree.lock_read()
2534
return _build_tree(tree, wt, accelerator_tree, hardlink,
2537
if accelerator_tree is not None:
2538
accelerator_tree.unlock()
2545
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2546
"""See build_tree."""
2547
for num, _unused in enumerate(wt.all_file_ids()):
2548
if num > 0: # more than just a root
2549
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2551
top_pb = ui.ui_factory.nested_progress_bar()
2552
pp = ProgressPhase("Build phase", 2, top_pb)
2553
if tree.get_root_id() is not None:
2554
# This is kind of a hack: we should be altering the root
2555
# as part of the regular tree shape diff logic.
2556
# The conditional test here is to avoid doing an
2557
# expensive operation (flush) every time the root id
2558
# is set within the tree, nor setting the root and thus
2559
# marking the tree as dirty, because we use two different
2560
# idioms here: tree interfaces and inventory interfaces.
2561
if wt.get_root_id() != tree.get_root_id():
2562
wt.set_root_id(tree.get_root_id())
2564
tt = TreeTransform(wt)
2568
file_trans_id[wt.get_root_id()] = \
2569
tt.trans_id_tree_file_id(wt.get_root_id())
2570
pb = ui.ui_factory.nested_progress_bar()
2572
deferred_contents = []
2574
total = len(tree.all_file_ids())
2576
precomputed_delta = []
2578
precomputed_delta = None
2579
# Check if tree inventory has content. If so, we populate
2580
# existing_files with the directory content. If there are no
2581
# entries we skip populating existing_files as its not used.
2582
# This improves performance and unncessary work on large
2583
# directory trees. (#501307)
2585
existing_files = set()
2586
for dir, files in wt.walkdirs():
2587
existing_files.update(f[0] for f in files)
2588
for num, (tree_path, entry) in \
2589
enumerate(tree.iter_entries_by_dir()):
2590
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2591
if entry.parent_id is None:
2594
file_id = entry.file_id
2596
precomputed_delta.append((None, tree_path, file_id, entry))
2597
if tree_path in existing_files:
2598
target_path = wt.abspath(tree_path)
2599
kind = file_kind(target_path)
2600
if kind == "directory":
2602
controldir.ControlDir.open(target_path)
2603
except errors.NotBranchError:
2607
if (file_id not in divert and
2608
_content_match(tree, entry, file_id, kind,
2610
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2611
if kind == 'directory':
2613
parent_id = file_trans_id[entry.parent_id]
2614
if entry.kind == 'file':
2615
# We *almost* replicate new_by_entry, so that we can defer
2616
# getting the file text, and get them all at once.
2617
trans_id = tt.create_path(entry.name, parent_id)
2618
file_trans_id[file_id] = trans_id
2619
tt.version_file(file_id, trans_id)
2620
executable = tree.is_executable(file_id, tree_path)
2622
tt.set_executability(executable, trans_id)
2623
trans_data = (trans_id, tree_path, entry.text_sha1)
2624
deferred_contents.append((file_id, trans_data))
2626
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2629
new_trans_id = file_trans_id[file_id]
2630
old_parent = tt.trans_id_tree_path(tree_path)
2631
_reparent_children(tt, old_parent, new_trans_id)
2632
offset = num + 1 - len(deferred_contents)
2633
_create_files(tt, tree, deferred_contents, pb, offset,
2634
accelerator_tree, hardlink)
2638
divert_trans = set(file_trans_id[f] for f in divert)
2639
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2640
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2641
if len(raw_conflicts) > 0:
2642
precomputed_delta = None
2643
conflicts = cook_conflicts(raw_conflicts, tt)
2644
for conflict in conflicts:
2645
trace.warning(unicode(conflict))
2647
wt.add_conflicts(conflicts)
2648
except errors.UnsupportedOperation:
2650
result = tt.apply(no_conflicts=True,
2651
precomputed_delta=precomputed_delta)
2658
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2660
total = len(desired_files) + offset
2662
if accelerator_tree is None:
2663
new_desired_files = desired_files
2665
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2666
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2667
in iter if not (c or e[0] != e[1])]
2668
if accelerator_tree.supports_content_filtering():
2669
unchanged = [(f, p) for (f, p) in unchanged
2670
if not next(accelerator_tree.iter_search_rules([p]))]
2671
unchanged = dict(unchanged)
2672
new_desired_files = []
2674
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2675
accelerator_path = unchanged.get(file_id)
2676
if accelerator_path is None:
2677
new_desired_files.append((file_id,
2678
(trans_id, tree_path, text_sha1)))
2680
pb.update(gettext('Adding file contents'), count + offset, total)
2682
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2685
contents = accelerator_tree.get_file(file_id, accelerator_path)
2686
if wt.supports_content_filtering():
2687
filters = wt._content_filter_stack(tree_path)
2688
contents = filtered_output_bytes(contents, filters,
2689
ContentFilterContext(tree_path, tree))
2691
tt.create_file(contents, trans_id, sha1=text_sha1)
2695
except AttributeError:
2696
# after filtering, contents may no longer be file-like
2700
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2701
tree.iter_files_bytes(new_desired_files)):
2702
if wt.supports_content_filtering():
2703
filters = wt._content_filter_stack(tree_path)
2704
contents = filtered_output_bytes(contents, filters,
2705
ContentFilterContext(tree_path, tree))
2706
tt.create_file(contents, trans_id, sha1=text_sha1)
2707
pb.update(gettext('Adding file contents'), count + offset, total)
2710
def _reparent_children(tt, old_parent, new_parent):
2711
for child in tt.iter_tree_children(old_parent):
2712
tt.adjust_path(tt.final_name(child), new_parent, child)
2715
def _reparent_transform_children(tt, old_parent, new_parent):
2716
by_parent = tt.by_parent()
2717
for child in by_parent[old_parent]:
2718
tt.adjust_path(tt.final_name(child), new_parent, child)
2719
return by_parent[old_parent]
2722
def _content_match(tree, entry, file_id, kind, target_path):
2723
if entry.kind != kind:
2725
if entry.kind == "directory":
2727
if entry.kind == "file":
2728
f = file(target_path, 'rb')
2730
if tree.get_file_text(file_id) == f.read():
2734
elif entry.kind == "symlink":
2735
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2740
def resolve_checkout(tt, conflicts, divert):
2741
new_conflicts = set()
2742
for c_type, conflict in ((c[0], c) for c in conflicts):
2743
# Anything but a 'duplicate' would indicate programmer error
2744
if c_type != 'duplicate':
2745
raise AssertionError(c_type)
2746
# Now figure out which is new and which is old
2747
if tt.new_contents(conflict[1]):
2748
new_file = conflict[1]
2749
old_file = conflict[2]
2751
new_file = conflict[2]
2752
old_file = conflict[1]
2754
# We should only get here if the conflict wasn't completely
2756
final_parent = tt.final_parent(old_file)
2757
if new_file in divert:
2758
new_name = tt.final_name(old_file)+'.diverted'
2759
tt.adjust_path(new_name, final_parent, new_file)
2760
new_conflicts.add((c_type, 'Diverted to',
2761
new_file, old_file))
2763
new_name = tt.final_name(old_file)+'.moved'
2764
tt.adjust_path(new_name, final_parent, old_file)
2765
new_conflicts.add((c_type, 'Moved existing file to',
2766
old_file, new_file))
2767
return new_conflicts
2770
def new_by_entry(tt, entry, parent_id, tree):
2771
"""Create a new file according to its inventory entry"""
2775
contents = tree.get_file(entry.file_id).readlines()
2776
executable = tree.is_executable(entry.file_id)
2777
return tt.new_file(name, parent_id, contents, entry.file_id,
2779
elif kind in ('directory', 'tree-reference'):
2780
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2781
if kind == 'tree-reference':
2782
tt.set_tree_reference(entry.reference_revision, trans_id)
2784
elif kind == 'symlink':
2785
target = tree.get_symlink_target(entry.file_id)
2786
return tt.new_symlink(name, parent_id, target, entry.file_id)
2788
raise errors.BadFileKindError(name, kind)
2791
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2792
filter_tree_path=None):
2793
"""Create new file contents according to tree contents.
2795
:param filter_tree_path: the tree path to use to lookup
2796
content filters to apply to the bytes output in the working tree.
2797
This only applies if the working tree supports content filtering.
2799
kind = tree.kind(file_id)
2800
if kind == 'directory':
2801
tt.create_directory(trans_id)
2802
elif kind == "file":
2804
tree_file = tree.get_file(file_id)
2806
bytes = tree_file.readlines()
2810
if wt.supports_content_filtering() and filter_tree_path is not None:
2811
filters = wt._content_filter_stack(filter_tree_path)
2812
bytes = filtered_output_bytes(bytes, filters,
2813
ContentFilterContext(filter_tree_path, tree))
2814
tt.create_file(bytes, trans_id)
2815
elif kind == "symlink":
2816
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2818
raise AssertionError('Unknown kind %r' % kind)
2821
def create_entry_executability(tt, entry, trans_id):
2822
"""Set the executability of a trans_id according to an inventory entry"""
2823
if entry.kind == "file":
2824
tt.set_executability(entry.executable, trans_id)
2827
def revert(working_tree, target_tree, filenames, backups=False,
2828
pb=None, change_reporter=None):
2829
"""Revert a working tree's contents to those of a target tree."""
2830
target_tree.lock_read()
2831
pb = ui.ui_factory.nested_progress_bar()
2832
tt = TreeTransform(working_tree, pb)
2834
pp = ProgressPhase("Revert phase", 3, pb)
2835
conflicts, merge_modified = _prepare_revert_transform(
2836
working_tree, target_tree, tt, filenames, backups, pp)
2838
change_reporter = delta._ChangeReporter(
2839
unversioned_filter=working_tree.is_ignored)
2840
delta.report_changes(tt.iter_changes(), change_reporter)
2841
for conflict in conflicts:
2842
trace.warning(unicode(conflict))
2845
working_tree.set_merge_modified(merge_modified)
2847
target_tree.unlock()
2853
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2854
backups, pp, basis_tree=None,
2855
merge_modified=None):
2856
child_pb = ui.ui_factory.nested_progress_bar()
2858
if merge_modified is None:
2859
merge_modified = working_tree.merge_modified()
2860
merge_modified = _alter_files(working_tree, target_tree, tt,
2861
child_pb, filenames, backups,
2862
merge_modified, basis_tree)
2865
child_pb = ui.ui_factory.nested_progress_bar()
2867
raw_conflicts = resolve_conflicts(tt, child_pb,
2868
lambda t, c: conflict_pass(t, c, target_tree))
2871
conflicts = cook_conflicts(raw_conflicts, tt)
2872
return conflicts, merge_modified
2875
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2876
backups, merge_modified, basis_tree=None):
2877
if basis_tree is not None:
2878
basis_tree.lock_read()
2879
# We ask the working_tree for its changes relative to the target, rather
2880
# than the target changes relative to the working tree. Because WT4 has an
2881
# optimizer to compare itself to a target, but no optimizer for the
2883
change_list = working_tree.iter_changes(target_tree,
2884
specific_files=specific_files, pb=pb)
2885
if target_tree.get_root_id() is None:
2891
for id_num, (file_id, path, changed_content, versioned, parent, name,
2892
kind, executable) in enumerate(change_list):
2893
target_path, wt_path = path
2894
target_versioned, wt_versioned = versioned
2895
target_parent, wt_parent = parent
2896
target_name, wt_name = name
2897
target_kind, wt_kind = kind
2898
target_executable, wt_executable = executable
2899
if skip_root and wt_parent is None:
2901
trans_id = tt.trans_id_file_id(file_id)
2904
keep_content = False
2905
if wt_kind == 'file' and (backups or target_kind is None):
2906
wt_sha1 = working_tree.get_file_sha1(file_id)
2907
if merge_modified.get(file_id) != wt_sha1:
2908
# acquire the basis tree lazily to prevent the
2909
# expense of accessing it when it's not needed ?
2910
# (Guessing, RBC, 200702)
2911
if basis_tree is None:
2912
basis_tree = working_tree.basis_tree()
2913
basis_tree.lock_read()
2914
if basis_tree.has_id(file_id):
2915
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2917
elif target_kind is None and not target_versioned:
2919
if wt_kind is not None:
2920
if not keep_content:
2921
tt.delete_contents(trans_id)
2922
elif target_kind is not None:
2923
parent_trans_id = tt.trans_id_file_id(wt_parent)
2924
backup_name = tt._available_backup_name(
2925
wt_name, parent_trans_id)
2926
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2927
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2928
if wt_versioned and target_versioned:
2929
tt.unversion_file(trans_id)
2930
tt.version_file(file_id, new_trans_id)
2931
# New contents should have the same unix perms as old
2934
trans_id = new_trans_id
2935
if target_kind in ('directory', 'tree-reference'):
2936
tt.create_directory(trans_id)
2937
if target_kind == 'tree-reference':
2938
revision = target_tree.get_reference_revision(file_id,
2940
tt.set_tree_reference(revision, trans_id)
2941
elif target_kind == 'symlink':
2942
tt.create_symlink(target_tree.get_symlink_target(file_id),
2944
elif target_kind == 'file':
2945
deferred_files.append((file_id, (trans_id, mode_id)))
2946
if basis_tree is None:
2947
basis_tree = working_tree.basis_tree()
2948
basis_tree.lock_read()
2949
new_sha1 = target_tree.get_file_sha1(file_id)
2950
if (basis_tree.has_id(file_id) and
2951
new_sha1 == basis_tree.get_file_sha1(file_id)):
2952
if file_id in merge_modified:
2953
del merge_modified[file_id]
2955
merge_modified[file_id] = new_sha1
2957
# preserve the execute bit when backing up
2958
if keep_content and wt_executable == target_executable:
2959
tt.set_executability(target_executable, trans_id)
2960
elif target_kind is not None:
2961
raise AssertionError(target_kind)
2962
if not wt_versioned and target_versioned:
2963
tt.version_file(file_id, trans_id)
2964
if wt_versioned and not target_versioned:
2965
tt.unversion_file(trans_id)
2966
if (target_name is not None and
2967
(wt_name != target_name or wt_parent != target_parent)):
2968
if target_name == '' and target_parent is None:
2969
parent_trans = ROOT_PARENT
2971
parent_trans = tt.trans_id_file_id(target_parent)
2972
if wt_parent is None and wt_versioned:
2973
tt.adjust_root_path(target_name, parent_trans)
2975
tt.adjust_path(target_name, parent_trans, trans_id)
2976
if wt_executable != target_executable and target_kind == "file":
2977
tt.set_executability(target_executable, trans_id)
2978
if working_tree.supports_content_filtering():
2979
for index, ((trans_id, mode_id), bytes) in enumerate(
2980
target_tree.iter_files_bytes(deferred_files)):
2981
file_id = deferred_files[index][0]
2982
# We're reverting a tree to the target tree so using the
2983
# target tree to find the file path seems the best choice
2984
# here IMO - Ian C 27/Oct/2009
2985
filter_tree_path = target_tree.id2path(file_id)
2986
filters = working_tree._content_filter_stack(filter_tree_path)
2987
bytes = filtered_output_bytes(bytes, filters,
2988
ContentFilterContext(filter_tree_path, working_tree))
2989
tt.create_file(bytes, trans_id, mode_id)
2991
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2993
tt.create_file(bytes, trans_id, mode_id)
2994
tt.fixup_new_roots()
2996
if basis_tree is not None:
2998
return merge_modified
3001
def resolve_conflicts(tt, pb=None, pass_func=None):
3002
"""Make many conflict-resolution attempts, but die if they fail"""
3003
if pass_func is None:
3004
pass_func = conflict_pass
3005
new_conflicts = set()
3006
pb = ui.ui_factory.nested_progress_bar()
3009
pb.update(gettext('Resolution pass'), n+1, 10)
3010
conflicts = tt.find_conflicts()
3011
if len(conflicts) == 0:
3012
return new_conflicts
3013
new_conflicts.update(pass_func(tt, conflicts))
3014
raise MalformedTransform(conflicts=conflicts)
3019
def conflict_pass(tt, conflicts, path_tree=None):
3020
"""Resolve some classes of conflicts.
3022
:param tt: The transform to resolve conflicts in
3023
:param conflicts: The conflicts to resolve
3024
:param path_tree: A Tree to get supplemental paths from
3026
new_conflicts = set()
3027
for c_type, conflict in ((c[0], c) for c in conflicts):
3028
if c_type == 'duplicate id':
3029
tt.unversion_file(conflict[1])
3030
new_conflicts.add((c_type, 'Unversioned existing file',
3031
conflict[1], conflict[2], ))
3032
elif c_type == 'duplicate':
3033
# files that were renamed take precedence
3034
final_parent = tt.final_parent(conflict[1])
3035
if tt.path_changed(conflict[1]):
3036
existing_file, new_file = conflict[2], conflict[1]
3038
existing_file, new_file = conflict[1], conflict[2]
3039
new_name = tt.final_name(existing_file) + '.moved'
3040
tt.adjust_path(new_name, final_parent, existing_file)
3041
new_conflicts.add((c_type, 'Moved existing file to',
3042
existing_file, new_file))
3043
elif c_type == 'parent loop':
3044
# break the loop by undoing one of the ops that caused the loop
3046
while not tt.path_changed(cur):
3047
cur = tt.final_parent(cur)
3048
new_conflicts.add((c_type, 'Cancelled move', cur,
3049
tt.final_parent(cur),))
3050
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3052
elif c_type == 'missing parent':
3053
trans_id = conflict[1]
3054
if trans_id in tt._removed_contents:
3055
cancel_deletion = True
3056
orphans = tt._get_potential_orphans(trans_id)
3058
cancel_deletion = False
3059
# All children are orphans
3062
tt.new_orphan(o, trans_id)
3063
except OrphaningError:
3064
# Something bad happened so we cancel the directory
3065
# deletion which will leave it in place with a
3066
# conflict. The user can deal with it from there.
3067
# Note that this also catch the case where we don't
3068
# want to create orphans and leave the directory in
3070
cancel_deletion = True
3073
# Cancel the directory deletion
3074
tt.cancel_deletion(trans_id)
3075
new_conflicts.add(('deleting parent', 'Not deleting',
3080
tt.final_name(trans_id)
3082
if path_tree is not None:
3083
file_id = tt.final_file_id(trans_id)
3085
file_id = tt.inactive_file_id(trans_id)
3086
_, entry = next(path_tree.iter_entries_by_dir(
3088
# special-case the other tree root (move its
3089
# children to current root)
3090
if entry.parent_id is None:
3092
moved = _reparent_transform_children(
3093
tt, trans_id, tt.root)
3095
new_conflicts.add((c_type, 'Moved to root',
3098
parent_trans_id = tt.trans_id_file_id(
3100
tt.adjust_path(entry.name, parent_trans_id,
3103
tt.create_directory(trans_id)
3104
new_conflicts.add((c_type, 'Created directory', trans_id))
3105
elif c_type == 'unversioned parent':
3106
file_id = tt.inactive_file_id(conflict[1])
3107
# special-case the other tree root (move its children instead)
3108
if path_tree and path_tree.has_id(file_id):
3109
if path_tree.path2id('') == file_id:
3110
# This is the root entry, skip it
3112
tt.version_file(file_id, conflict[1])
3113
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3114
elif c_type == 'non-directory parent':
3115
parent_id = conflict[1]
3116
parent_parent = tt.final_parent(parent_id)
3117
parent_name = tt.final_name(parent_id)
3118
parent_file_id = tt.final_file_id(parent_id)
3119
new_parent_id = tt.new_directory(parent_name + '.new',
3120
parent_parent, parent_file_id)
3121
_reparent_transform_children(tt, parent_id, new_parent_id)
3122
if parent_file_id is not None:
3123
tt.unversion_file(parent_id)
3124
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3125
elif c_type == 'versioning no contents':
3126
tt.cancel_versioning(conflict[1])
3127
return new_conflicts
3130
def cook_conflicts(raw_conflicts, tt):
3131
"""Generate a list of cooked conflicts, sorted by file path"""
3132
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3133
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3136
def iter_cook_conflicts(raw_conflicts, tt):
3138
for conflict in raw_conflicts:
3139
c_type = conflict[0]
3140
action = conflict[1]
3141
modified_path = fp.get_path(conflict[2])
3142
modified_id = tt.final_file_id(conflict[2])
3143
if len(conflict) == 3:
3144
yield conflicts.Conflict.factory(
3145
c_type, action=action, path=modified_path, file_id=modified_id)
3148
conflicting_path = fp.get_path(conflict[3])
3149
conflicting_id = tt.final_file_id(conflict[3])
3150
yield conflicts.Conflict.factory(
3151
c_type, action=action, path=modified_path,
3152
file_id=modified_id,
3153
conflict_path=conflicting_path,
3154
conflict_file_id=conflicting_id)
3157
class _FileMover(object):
3158
"""Moves and deletes files for TreeTransform, tracking operations"""
3161
self.past_renames = []
3162
self.pending_deletions = []
3164
def rename(self, from_, to):
3165
"""Rename a file from one path to another."""
3167
os.rename(from_, to)
3168
except OSError as e:
3169
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3170
raise errors.FileExists(to, str(e))
3171
# normal OSError doesn't include filenames so it's hard to see where
3172
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3173
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3174
self.past_renames.append((from_, to))
3176
def pre_delete(self, from_, to):
3177
"""Rename a file out of the way and mark it for deletion.
3179
Unlike os.unlink, this works equally well for files and directories.
3180
:param from_: The current file path
3181
:param to: A temporary path for the file
3183
self.rename(from_, to)
3184
self.pending_deletions.append(to)
3187
"""Reverse all renames that have been performed"""
3188
for from_, to in reversed(self.past_renames):
3190
os.rename(to, from_)
3191
except OSError as e:
3192
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3193
# after rollback, don't reuse _FileMover
3195
pending_deletions = None
3197
def apply_deletions(self):
3198
"""Apply all marked deletions"""
3199
for path in self.pending_deletions:
3201
# after apply_deletions, don't reuse _FileMover
3203
pending_deletions = None
added
removed
breezy/transform.py
