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(), """
42
revision as _mod_revision,
46
from breezy.bzr import (
50
from breezy.i18n import gettext
52
from .errors import (DuplicateKey, MalformedTransform,
53
ReusingTransform, CantMoveRoot,
54
ImmortalLimbo, NoFinalPath,
56
from .filters import filtered_output_bytes, ContentFilterContext
57
from .mutabletree import MutableTree
58
from .osutils import (
66
from .progress import ProgressPhase
73
ROOT_PARENT = "root-parent"
75
def unique_add(map, key, value):
77
raise DuplicateKey(key=key)
82
class _TransformResults(object):
83
def __init__(self, modified_paths, rename_count):
85
self.modified_paths = modified_paths
86
self.rename_count = rename_count
89
class TreeTransformBase(object):
90
"""The base class for TreeTransform and its kin."""
92
def __init__(self, tree, pb=None,
96
:param tree: The tree that will be transformed, but not necessarily
99
:param case_sensitive: If True, the target of the transform is
100
case sensitive, not just case preserving.
102
object.__init__(self)
105
# mapping of trans_id -> new basename
107
# mapping of trans_id -> new parent trans_id
108
self._new_parent = {}
109
# mapping of trans_id with new contents -> new file_kind
110
self._new_contents = {}
111
# mapping of trans_id => (sha1 of content, stat_value)
112
self._observed_sha1s = {}
113
# Set of trans_ids whose contents will be removed
114
self._removed_contents = set()
115
# Mapping of trans_id -> new execute-bit value
116
self._new_executability = {}
117
# Mapping of trans_id -> new tree-reference value
118
self._new_reference_revision = {}
119
# Mapping of trans_id -> new file_id
121
# Mapping of old file-id -> trans_id
122
self._non_present_ids = {}
123
# Mapping of new file_id -> trans_id
125
# Set of trans_ids that will be removed
126
self._removed_id = set()
127
# Mapping of path in old tree -> trans_id
128
self._tree_path_ids = {}
129
# Mapping trans_id -> path in old tree
130
self._tree_id_paths = {}
131
# The trans_id that will be used as the tree root
132
root_id = tree.get_root_id()
133
if root_id is not None:
134
self._new_root = self.trans_id_tree_file_id(root_id)
136
self._new_root = None
137
# Indicator of whether the transform has been applied
141
# Whether the target is case sensitive
142
self._case_sensitive_target = case_sensitive
143
# A counter of how many files have been renamed
144
self.rename_count = 0
147
"""Support Context Manager API."""
150
def __exit__(self, exc_type, exc_val, exc_tb):
151
"""Support Context Manager API."""
155
"""Release the working tree lock, if held.
157
This is required if apply has not been invoked, but can be invoked
160
if self._tree is None:
162
for hook in MutableTree.hooks['post_transform']:
163
hook(self._tree, self)
167
def __get_root(self):
168
return self._new_root
170
root = property(__get_root)
172
def _assign_id(self):
173
"""Produce a new tranform id"""
174
new_id = "new-%s" % self._id_number
178
def create_path(self, name, parent):
179
"""Assign a transaction id to a new path"""
180
trans_id = self._assign_id()
181
unique_add(self._new_name, trans_id, name)
182
unique_add(self._new_parent, trans_id, parent)
185
def adjust_path(self, name, parent, trans_id):
186
"""Change the path that is assigned to a transaction id."""
188
raise ValueError("Parent trans-id may not be None")
189
if trans_id == self._new_root:
191
self._new_name[trans_id] = name
192
self._new_parent[trans_id] = parent
194
def adjust_root_path(self, name, parent):
195
"""Emulate moving the root by moving all children, instead.
197
We do this by undoing the association of root's transaction id with the
198
current tree. This allows us to create a new directory with that
199
transaction id. We unversion the root directory and version the
200
physically new directory, and hope someone versions the tree root
203
old_root = self._new_root
204
old_root_file_id = self.final_file_id(old_root)
205
# force moving all children of root
206
for child_id in self.iter_tree_children(old_root):
207
if child_id != parent:
208
self.adjust_path(self.final_name(child_id),
209
self.final_parent(child_id), child_id)
210
file_id = self.final_file_id(child_id)
211
if file_id is not None:
212
self.unversion_file(child_id)
213
self.version_file(file_id, child_id)
215
# the physical root needs a new transaction id
216
self._tree_path_ids.pop("")
217
self._tree_id_paths.pop(old_root)
218
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
219
if parent == old_root:
220
parent = self._new_root
221
self.adjust_path(name, parent, old_root)
222
self.create_directory(old_root)
223
self.version_file(old_root_file_id, old_root)
224
self.unversion_file(self._new_root)
226
def fixup_new_roots(self):
227
"""Reinterpret requests to change the root directory
229
Instead of creating a root directory, or moving an existing directory,
230
all the attributes and children of the new root are applied to the
231
existing root directory.
233
This means that the old root trans-id becomes obsolete, so it is
234
recommended only to invoke this after the root trans-id has become
238
new_roots = [k for k, v in viewitems(self._new_parent)
240
if len(new_roots) < 1:
242
if len(new_roots) != 1:
243
raise ValueError('A tree cannot have two roots!')
244
if self._new_root is None:
245
self._new_root = new_roots[0]
247
old_new_root = new_roots[0]
248
# unversion the new root's directory.
249
if self.final_kind(self._new_root) is None:
250
file_id = self.final_file_id(old_new_root)
252
file_id = self.final_file_id(self._new_root)
253
if old_new_root in self._new_id:
254
self.cancel_versioning(old_new_root)
256
self.unversion_file(old_new_root)
257
# if, at this stage, root still has an old file_id, zap it so we can
258
# stick a new one in.
259
if (self.tree_file_id(self._new_root) is not None and
260
self._new_root not in self._removed_id):
261
self.unversion_file(self._new_root)
262
if file_id is not None:
263
self.version_file(file_id, self._new_root)
265
# Now move children of new root into old root directory.
266
# Ensure all children are registered with the transaction, but don't
267
# use directly-- some tree children have new parents
268
list(self.iter_tree_children(old_new_root))
269
# Move all children of new root into old root directory.
270
for child in self.by_parent().get(old_new_root, []):
271
self.adjust_path(self.final_name(child), self._new_root, child)
273
# Ensure old_new_root has no directory.
274
if old_new_root in self._new_contents:
275
self.cancel_creation(old_new_root)
277
self.delete_contents(old_new_root)
279
# prevent deletion of root directory.
280
if self._new_root in self._removed_contents:
281
self.cancel_deletion(self._new_root)
283
# destroy path info for old_new_root.
284
del self._new_parent[old_new_root]
285
del self._new_name[old_new_root]
287
def trans_id_tree_file_id(self, inventory_id):
288
"""Determine the transaction id of a working tree file.
290
This reflects only files that already exist, not ones that will be
291
added by transactions.
293
if inventory_id is None:
294
raise ValueError('None is not a valid file id')
295
path = self._tree.id2path(inventory_id)
296
return self.trans_id_tree_path(path)
298
def trans_id_file_id(self, file_id):
299
"""Determine or set the transaction id associated with a file ID.
300
A new id is only created for file_ids that were never present. If
301
a transaction has been unversioned, it is deliberately still returned.
302
(this will likely lead to an unversioned parent conflict.)
305
raise ValueError('None is not a valid file id')
306
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
307
return self._r_new_id[file_id]
310
next(self._tree.iter_entries_by_dir([file_id]))
311
except StopIteration:
312
if file_id in self._non_present_ids:
313
return self._non_present_ids[file_id]
315
trans_id = self._assign_id()
316
self._non_present_ids[file_id] = trans_id
319
return self.trans_id_tree_file_id(file_id)
321
def trans_id_tree_path(self, path):
322
"""Determine (and maybe set) the transaction ID for a tree path."""
323
path = self.canonical_path(path)
324
if path not in self._tree_path_ids:
325
self._tree_path_ids[path] = self._assign_id()
326
self._tree_id_paths[self._tree_path_ids[path]] = path
327
return self._tree_path_ids[path]
329
def get_tree_parent(self, trans_id):
330
"""Determine id of the parent in the tree."""
331
path = self._tree_id_paths[trans_id]
334
return self.trans_id_tree_path(os.path.dirname(path))
336
def delete_contents(self, trans_id):
337
"""Schedule the contents of a path entry for deletion"""
338
kind = self.tree_kind(trans_id)
340
self._removed_contents.add(trans_id)
342
def cancel_deletion(self, trans_id):
343
"""Cancel a scheduled deletion"""
344
self._removed_contents.remove(trans_id)
346
def unversion_file(self, trans_id):
347
"""Schedule a path entry to become unversioned"""
348
self._removed_id.add(trans_id)
350
def delete_versioned(self, trans_id):
351
"""Delete and unversion a versioned file"""
352
self.delete_contents(trans_id)
353
self.unversion_file(trans_id)
355
def set_executability(self, executability, trans_id):
356
"""Schedule setting of the 'execute' bit
357
To unschedule, set to None
359
if executability is None:
360
del self._new_executability[trans_id]
362
unique_add(self._new_executability, trans_id, executability)
364
def set_tree_reference(self, revision_id, trans_id):
365
"""Set the reference associated with a directory"""
366
unique_add(self._new_reference_revision, trans_id, revision_id)
368
def version_file(self, file_id, trans_id):
369
"""Schedule a file to become versioned."""
372
unique_add(self._new_id, trans_id, file_id)
373
unique_add(self._r_new_id, file_id, trans_id)
375
def cancel_versioning(self, trans_id):
376
"""Undo a previous versioning of a file"""
377
file_id = self._new_id[trans_id]
378
del self._new_id[trans_id]
379
del self._r_new_id[file_id]
381
def new_paths(self, filesystem_only=False):
382
"""Determine the paths of all new and changed files.
384
:param filesystem_only: if True, only calculate values for files
385
that require renames or execute bit changes.
389
stale_ids = self._needs_rename.difference(self._new_name)
390
stale_ids.difference_update(self._new_parent)
391
stale_ids.difference_update(self._new_contents)
392
stale_ids.difference_update(self._new_id)
393
needs_rename = self._needs_rename.difference(stale_ids)
394
id_sets = (needs_rename, self._new_executability)
396
id_sets = (self._new_name, self._new_parent, self._new_contents,
397
self._new_id, self._new_executability)
398
for id_set in id_sets:
399
new_ids.update(id_set)
400
return sorted(FinalPaths(self).get_paths(new_ids))
402
def _inventory_altered(self):
403
"""Determine which trans_ids need new Inventory entries.
405
An new entry is needed when anything that would be reflected by an
406
inventory entry changes, including file name, file_id, parent file_id,
407
file kind, and the execute bit.
409
Some care is taken to return entries with real changes, not cases
410
where the value is deleted and then restored to its original value,
411
but some actually unchanged values may be returned.
413
:returns: A list of (path, trans_id) for all items requiring an
414
inventory change. Ordered by path.
417
# Find entries whose file_ids are new (or changed).
418
new_file_id = set(t for t in self._new_id
419
if self._new_id[t] != self.tree_file_id(t))
420
for id_set in [self._new_name, self._new_parent, new_file_id,
421
self._new_executability]:
422
changed_ids.update(id_set)
423
# removing implies a kind change
424
changed_kind = set(self._removed_contents)
426
changed_kind.intersection_update(self._new_contents)
427
# Ignore entries that are already known to have changed.
428
changed_kind.difference_update(changed_ids)
429
# to keep only the truly changed ones
430
changed_kind = (t for t in changed_kind
431
if self.tree_kind(t) != self.final_kind(t))
432
# all kind changes will alter the inventory
433
changed_ids.update(changed_kind)
434
# To find entries with changed parent_ids, find parents which existed,
435
# but changed file_id.
436
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
437
# Now add all their children to the set.
438
for parent_trans_id in new_file_id:
439
changed_ids.update(self.iter_tree_children(parent_trans_id))
440
return sorted(FinalPaths(self).get_paths(changed_ids))
442
def final_kind(self, trans_id):
443
"""Determine the final file kind, after any changes applied.
445
:return: None if the file does not exist/has no contents. (It is
446
conceivable that a path would be created without the corresponding
447
contents insertion command)
449
if trans_id in self._new_contents:
450
return self._new_contents[trans_id]
451
elif trans_id in self._removed_contents:
454
return self.tree_kind(trans_id)
456
def tree_file_id(self, trans_id):
457
"""Determine the file id associated with the trans_id in the tree"""
459
path = self._tree_id_paths[trans_id]
461
# the file is a new, unversioned file, or invalid trans_id
463
# the file is old; the old id is still valid
464
if self._new_root == trans_id:
465
return self._tree.get_root_id()
466
return self._tree.path2id(path)
468
def final_file_id(self, trans_id):
469
"""Determine the file id after any changes are applied, or None.
471
None indicates that the file will not be versioned after changes are
475
return self._new_id[trans_id]
477
if trans_id in self._removed_id:
479
return self.tree_file_id(trans_id)
481
def inactive_file_id(self, trans_id):
482
"""Return the inactive file_id associated with a transaction id.
483
That is, the one in the tree or in non_present_ids.
484
The file_id may actually be active, too.
486
file_id = self.tree_file_id(trans_id)
487
if file_id is not None:
489
for key, value in viewitems(self._non_present_ids):
490
if value == trans_id:
493
def final_parent(self, trans_id):
494
"""Determine the parent file_id, after any changes are applied.
496
ROOT_PARENT is returned for the tree root.
499
return self._new_parent[trans_id]
501
return self.get_tree_parent(trans_id)
503
def final_name(self, trans_id):
504
"""Determine the final filename, after all changes are applied."""
506
return self._new_name[trans_id]
509
return os.path.basename(self._tree_id_paths[trans_id])
511
raise NoFinalPath(trans_id, self)
514
"""Return a map of parent: children for known parents.
516
Only new paths and parents of tree files with assigned ids are used.
519
items = list(viewitems(self._new_parent))
520
items.extend((t, self.final_parent(t))
521
for t in list(self._tree_id_paths))
522
for trans_id, parent_id in items:
523
if parent_id not in by_parent:
524
by_parent[parent_id] = set()
525
by_parent[parent_id].add(trans_id)
528
def path_changed(self, trans_id):
529
"""Return True if a trans_id's path has changed."""
530
return (trans_id in self._new_name) or (trans_id in self._new_parent)
532
def new_contents(self, trans_id):
533
return (trans_id in self._new_contents)
535
def find_conflicts(self):
536
"""Find any violations of inventory or filesystem invariants"""
537
if self._done is True:
538
raise ReusingTransform()
540
# ensure all children of all existent parents are known
541
# all children of non-existent parents are known, by definition.
542
self._add_tree_children()
543
by_parent = self.by_parent()
544
conflicts.extend(self._unversioned_parents(by_parent))
545
conflicts.extend(self._parent_loops())
546
conflicts.extend(self._duplicate_entries(by_parent))
547
conflicts.extend(self._duplicate_ids())
548
conflicts.extend(self._parent_type_conflicts(by_parent))
549
conflicts.extend(self._improper_versioning())
550
conflicts.extend(self._executability_conflicts())
551
conflicts.extend(self._overwrite_conflicts())
554
def _check_malformed(self):
555
conflicts = self.find_conflicts()
556
if len(conflicts) != 0:
557
raise MalformedTransform(conflicts=conflicts)
559
def _add_tree_children(self):
560
"""Add all the children of all active parents to the known paths.
562
Active parents are those which gain children, and those which are
563
removed. This is a necessary first step in detecting conflicts.
565
parents = list(self.by_parent())
566
parents.extend([t for t in self._removed_contents if
567
self.tree_kind(t) == 'directory'])
568
for trans_id in self._removed_id:
569
file_id = self.tree_file_id(trans_id)
570
if file_id is not None:
571
if self._tree.stored_kind(file_id) == 'directory':
572
parents.append(trans_id)
573
elif self.tree_kind(trans_id) == 'directory':
574
parents.append(trans_id)
576
for parent_id in parents:
577
# ensure that all children are registered with the transaction
578
list(self.iter_tree_children(parent_id))
580
def _has_named_child(self, name, parent_id, known_children):
581
"""Does a parent already have a name child.
583
:param name: The searched for name.
585
:param parent_id: The parent for which the check is made.
587
:param known_children: The already known children. This should have
588
been recently obtained from `self.by_parent.get(parent_id)`
589
(or will be if None is passed).
591
if known_children is None:
592
known_children = self.by_parent().get(parent_id, [])
593
for child in known_children:
594
if self.final_name(child) == name:
596
parent_path = self._tree_id_paths.get(parent_id, None)
597
if parent_path is None:
598
# No parent... no children
600
child_path = joinpath(parent_path, name)
601
child_id = self._tree_path_ids.get(child_path, None)
603
# Not known by the tree transform yet, check the filesystem
604
return osutils.lexists(self._tree.abspath(child_path))
606
raise AssertionError('child_id is missing: %s, %s, %s'
607
% (name, parent_id, child_id))
609
def _available_backup_name(self, name, target_id):
610
"""Find an available backup name.
612
:param name: The basename of the file.
614
:param target_id: The directory trans_id where the backup should
617
known_children = self.by_parent().get(target_id, [])
618
return osutils.available_backup_name(
620
lambda base: self._has_named_child(
621
base, target_id, known_children))
623
def _parent_loops(self):
624
"""No entry should be its own ancestor"""
626
for trans_id in self._new_parent:
629
while parent_id != ROOT_PARENT:
632
parent_id = self.final_parent(parent_id)
635
if parent_id == trans_id:
636
conflicts.append(('parent loop', trans_id))
637
if parent_id in seen:
641
def _unversioned_parents(self, by_parent):
642
"""If parent directories are versioned, children must be versioned."""
644
for parent_id, children in viewitems(by_parent):
645
if parent_id == ROOT_PARENT:
647
if self.final_file_id(parent_id) is not None:
649
for child_id in children:
650
if self.final_file_id(child_id) is not None:
651
conflicts.append(('unversioned parent', parent_id))
655
def _improper_versioning(self):
656
"""Cannot version a file with no contents, or a bad type.
658
However, existing entries with no contents are okay.
661
for trans_id in self._new_id:
662
kind = self.final_kind(trans_id)
664
conflicts.append(('versioning no contents', trans_id))
666
if not inventory.InventoryEntry.versionable_kind(kind):
667
conflicts.append(('versioning bad kind', trans_id, kind))
670
def _executability_conflicts(self):
671
"""Check for bad executability changes.
673
Only versioned files may have their executability set, because
674
1. only versioned entries can have executability under windows
675
2. only files can be executable. (The execute bit on a directory
676
does not indicate searchability)
679
for trans_id in self._new_executability:
680
if self.final_file_id(trans_id) is None:
681
conflicts.append(('unversioned executability', trans_id))
683
if self.final_kind(trans_id) != "file":
684
conflicts.append(('non-file executability', trans_id))
687
def _overwrite_conflicts(self):
688
"""Check for overwrites (not permitted on Win32)"""
690
for trans_id in self._new_contents:
691
if self.tree_kind(trans_id) is None:
693
if trans_id not in self._removed_contents:
694
conflicts.append(('overwrite', trans_id,
695
self.final_name(trans_id)))
698
def _duplicate_entries(self, by_parent):
699
"""No directory may have two entries with the same name."""
701
if (self._new_name, self._new_parent) == ({}, {}):
703
for children in viewvalues(by_parent):
705
for child_tid in children:
706
name = self.final_name(child_tid)
708
# Keep children only if they still exist in the end
709
if not self._case_sensitive_target:
711
name_ids.append((name, child_tid))
715
for name, trans_id in name_ids:
716
kind = self.final_kind(trans_id)
717
file_id = self.final_file_id(trans_id)
718
if kind is None and file_id is None:
720
if name == last_name:
721
conflicts.append(('duplicate', last_trans_id, trans_id,
724
last_trans_id = trans_id
727
def _duplicate_ids(self):
728
"""Each inventory id may only be used once"""
730
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
732
all_ids = self._tree.all_file_ids()
733
active_tree_ids = all_ids.difference(removed_tree_ids)
734
for trans_id, file_id in viewitems(self._new_id):
735
if file_id in active_tree_ids:
736
old_trans_id = self.trans_id_tree_file_id(file_id)
737
conflicts.append(('duplicate id', old_trans_id, trans_id))
740
def _parent_type_conflicts(self, by_parent):
741
"""Children must have a directory parent"""
743
for parent_id, children in viewitems(by_parent):
744
if parent_id == ROOT_PARENT:
747
for child_id in children:
748
if self.final_kind(child_id) is not None:
753
# There is at least a child, so we need an existing directory to
755
kind = self.final_kind(parent_id)
757
# The directory will be deleted
758
conflicts.append(('missing parent', parent_id))
759
elif kind != "directory":
760
# Meh, we need a *directory* to put something in it
761
conflicts.append(('non-directory parent', parent_id))
764
def _set_executability(self, path, trans_id):
765
"""Set the executability of versioned files """
766
if self._tree._supports_executable():
767
new_executability = self._new_executability[trans_id]
768
abspath = self._tree.abspath(path)
769
current_mode = os.stat(abspath).st_mode
770
if new_executability:
773
to_mode = current_mode | (0o100 & ~umask)
774
# Enable x-bit for others only if they can read it.
775
if current_mode & 0o004:
776
to_mode |= 0o001 & ~umask
777
if current_mode & 0o040:
778
to_mode |= 0o010 & ~umask
780
to_mode = current_mode & ~0o111
781
osutils.chmod_if_possible(abspath, to_mode)
783
def _new_entry(self, name, parent_id, file_id):
784
"""Helper function to create a new filesystem entry."""
785
trans_id = self.create_path(name, parent_id)
786
if file_id is not None:
787
self.version_file(file_id, trans_id)
790
def new_file(self, name, parent_id, contents, file_id=None,
791
executable=None, sha1=None):
792
"""Convenience method to create files.
794
name is the name of the file to create.
795
parent_id is the transaction id of the parent directory of the file.
796
contents is an iterator of bytestrings, which will be used to produce
798
:param file_id: The inventory ID of the file, if it is to be versioned.
799
:param executable: Only valid when a file_id has been supplied.
801
trans_id = self._new_entry(name, parent_id, file_id)
802
# TODO: rather than scheduling a set_executable call,
803
# have create_file create the file with the right mode.
804
self.create_file(contents, trans_id, sha1=sha1)
805
if executable is not None:
806
self.set_executability(executable, trans_id)
809
def new_directory(self, name, parent_id, file_id=None):
810
"""Convenience method to create directories.
812
name is the name of the directory to create.
813
parent_id is the transaction id of the parent directory of the
815
file_id is the inventory ID of the directory, if it is to be versioned.
817
trans_id = self._new_entry(name, parent_id, file_id)
818
self.create_directory(trans_id)
821
def new_symlink(self, name, parent_id, target, file_id=None):
822
"""Convenience method to create symbolic link.
824
name is the name of the symlink to create.
825
parent_id is the transaction id of the parent directory of the symlink.
826
target is a bytestring of the target of the symlink.
827
file_id is the inventory ID of the file, if it is to be versioned.
829
trans_id = self._new_entry(name, parent_id, file_id)
830
self.create_symlink(target, trans_id)
833
def new_orphan(self, trans_id, parent_id):
834
"""Schedule an item to be orphaned.
836
When a directory is about to be removed, its children, if they are not
837
versioned are moved out of the way: they don't have a parent anymore.
839
:param trans_id: The trans_id of the existing item.
840
:param parent_id: The parent trans_id of the item.
842
raise NotImplementedError(self.new_orphan)
844
def _get_potential_orphans(self, dir_id):
845
"""Find the potential orphans in a directory.
847
A directory can't be safely deleted if there are versioned files in it.
848
If all the contained files are unversioned then they can be orphaned.
850
The 'None' return value means that the directory contains at least one
851
versioned file and should not be deleted.
853
:param dir_id: The directory trans id.
855
:return: A list of the orphan trans ids or None if at least one
856
versioned file is present.
859
# Find the potential orphans, stop if one item should be kept
860
for child_tid in self.by_parent()[dir_id]:
861
if child_tid in self._removed_contents:
862
# The child is removed as part of the transform. Since it was
863
# versioned before, it's not an orphan
865
elif self.final_file_id(child_tid) is None:
866
# The child is not versioned
867
orphans.append(child_tid)
869
# We have a versioned file here, searching for orphans is
875
def _affected_ids(self):
876
"""Return the set of transform ids affected by the transform"""
877
trans_ids = set(self._removed_id)
878
trans_ids.update(self._new_id)
879
trans_ids.update(self._removed_contents)
880
trans_ids.update(self._new_contents)
881
trans_ids.update(self._new_executability)
882
trans_ids.update(self._new_name)
883
trans_ids.update(self._new_parent)
886
def _get_file_id_maps(self):
887
"""Return mapping of file_ids to trans_ids in the to and from states"""
888
trans_ids = self._affected_ids()
891
# Build up two dicts: trans_ids associated with file ids in the
892
# FROM state, vs the TO state.
893
for trans_id in trans_ids:
894
from_file_id = self.tree_file_id(trans_id)
895
if from_file_id is not None:
896
from_trans_ids[from_file_id] = trans_id
897
to_file_id = self.final_file_id(trans_id)
898
if to_file_id is not None:
899
to_trans_ids[to_file_id] = trans_id
900
return from_trans_ids, to_trans_ids
902
def _from_file_data(self, from_trans_id, from_versioned, file_id):
903
"""Get data about a file in the from (tree) state
905
Return a (name, parent, kind, executable) tuple
907
from_path = self._tree_id_paths.get(from_trans_id)
909
# get data from working tree if versioned
910
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
911
from_name = from_entry.name
912
from_parent = from_entry.parent_id
915
if from_path is None:
916
# File does not exist in FROM state
920
# File exists, but is not versioned. Have to use path-
922
from_name = os.path.basename(from_path)
923
tree_parent = self.get_tree_parent(from_trans_id)
924
from_parent = self.tree_file_id(tree_parent)
925
if from_path is not None:
926
from_kind, from_executable, from_stats = \
927
self._tree._comparison_data(from_entry, from_path)
930
from_executable = False
931
return from_name, from_parent, from_kind, from_executable
933
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
934
"""Get data about a file in the to (target) state
936
Return a (name, parent, kind, executable) tuple
938
to_name = self.final_name(to_trans_id)
939
to_kind = self.final_kind(to_trans_id)
940
to_parent = self.final_file_id(self.final_parent(to_trans_id))
941
if to_trans_id in self._new_executability:
942
to_executable = self._new_executability[to_trans_id]
943
elif to_trans_id == from_trans_id:
944
to_executable = from_executable
946
to_executable = False
947
return to_name, to_parent, to_kind, to_executable
949
def iter_changes(self):
950
"""Produce output in the same format as Tree.iter_changes.
952
Will produce nonsensical results if invoked while inventory/filesystem
953
conflicts (as reported by TreeTransform.find_conflicts()) are present.
955
This reads the Transform, but only reproduces changes involving a
956
file_id. Files that are not versioned in either of the FROM or TO
957
states are not reflected.
959
final_paths = FinalPaths(self)
960
from_trans_ids, to_trans_ids = self._get_file_id_maps()
962
# Now iterate through all active file_ids
963
for file_id in set(from_trans_ids).union(to_trans_ids):
965
from_trans_id = from_trans_ids.get(file_id)
966
# find file ids, and determine versioning state
967
if from_trans_id is None:
968
from_versioned = False
969
from_trans_id = to_trans_ids[file_id]
971
from_versioned = True
972
to_trans_id = to_trans_ids.get(file_id)
973
if to_trans_id is None:
975
to_trans_id = from_trans_id
979
from_name, from_parent, from_kind, from_executable = \
980
self._from_file_data(from_trans_id, from_versioned, file_id)
982
to_name, to_parent, to_kind, to_executable = \
983
self._to_file_data(to_trans_id, from_trans_id, from_executable)
985
if not from_versioned:
988
from_path = self._tree_id_paths.get(from_trans_id)
992
to_path = final_paths.get_path(to_trans_id)
993
if from_kind != to_kind:
995
elif to_kind in ('file', 'symlink') and (
996
to_trans_id != from_trans_id or
997
to_trans_id in self._new_contents):
999
if (not modified and from_versioned == to_versioned and
1000
from_parent==to_parent and from_name == to_name and
1001
from_executable == to_executable):
1003
results.append((file_id, (from_path, to_path), modified,
1004
(from_versioned, to_versioned),
1005
(from_parent, to_parent),
1006
(from_name, to_name),
1007
(from_kind, to_kind),
1008
(from_executable, to_executable)))
1009
return iter(sorted(results, key=lambda x:x[1]))
1011
def get_preview_tree(self):
1012
"""Return a tree representing the result of the transform.
1014
The tree is a snapshot, and altering the TreeTransform will invalidate
1017
return _PreviewTree(self)
1019
def commit(self, branch, message, merge_parents=None, strict=False,
1020
timestamp=None, timezone=None, committer=None, authors=None,
1021
revprops=None, revision_id=None):
1022
"""Commit the result of this TreeTransform to a branch.
1024
:param branch: The branch to commit to.
1025
:param message: The message to attach to the commit.
1026
:param merge_parents: Additional parent revision-ids specified by
1028
:param strict: If True, abort the commit if there are unversioned
1030
:param timestamp: if not None, seconds-since-epoch for the time and
1031
date. (May be a float.)
1032
:param timezone: Optional timezone for timestamp, as an offset in
1034
:param committer: Optional committer in email-id format.
1035
(e.g. "J Random Hacker <jrandom@example.com>")
1036
:param authors: Optional list of authors in email-id format.
1037
:param revprops: Optional dictionary of revision properties.
1038
:param revision_id: Optional revision id. (Specifying a revision-id
1039
may reduce performance for some non-native formats.)
1040
:return: The revision_id of the revision committed.
1042
self._check_malformed()
1044
unversioned = set(self._new_contents).difference(set(self._new_id))
1045
for trans_id in unversioned:
1046
if self.final_file_id(trans_id) is None:
1047
raise errors.StrictCommitFailed()
1049
revno, last_rev_id = branch.last_revision_info()
1050
if last_rev_id == _mod_revision.NULL_REVISION:
1051
if merge_parents is not None:
1052
raise ValueError('Cannot supply merge parents for first'
1056
parent_ids = [last_rev_id]
1057
if merge_parents is not None:
1058
parent_ids.extend(merge_parents)
1059
if self._tree.get_revision_id() != last_rev_id:
1060
raise ValueError('TreeTransform not based on branch basis: %s' %
1061
self._tree.get_revision_id())
1062
revprops = commit.Commit.update_revprops(revprops, branch, authors)
1063
builder = branch.get_commit_builder(parent_ids,
1064
timestamp=timestamp,
1066
committer=committer,
1068
revision_id=revision_id)
1069
preview = self.get_preview_tree()
1070
list(builder.record_iter_changes(preview, last_rev_id,
1071
self.iter_changes()))
1072
builder.finish_inventory()
1073
revision_id = builder.commit(message)
1074
branch.set_last_revision_info(revno + 1, revision_id)
1077
def _text_parent(self, trans_id):
1078
file_id = self.tree_file_id(trans_id)
1080
if file_id is None or self._tree.kind(file_id) != 'file':
1082
except errors.NoSuchFile:
1086
def _get_parents_texts(self, trans_id):
1087
"""Get texts for compression parents of this file."""
1088
file_id = self._text_parent(trans_id)
1091
return (self._tree.get_file_text(file_id),)
1093
def _get_parents_lines(self, trans_id):
1094
"""Get lines for compression parents of this file."""
1095
file_id = self._text_parent(trans_id)
1098
return (self._tree.get_file_lines(file_id),)
1100
def serialize(self, serializer):
1101
"""Serialize this TreeTransform.
1103
:param serializer: A Serialiser like pack.ContainerSerializer.
1105
new_name = dict((k, v.encode('utf-8')) for k, v in
1106
viewitems(self._new_name))
1107
new_executability = dict((k, int(v)) for k, v in
1108
viewitems(self._new_executability))
1109
tree_path_ids = dict((k.encode('utf-8'), v)
1110
for k, v in viewitems(self._tree_path_ids))
1112
'_id_number': self._id_number,
1113
'_new_name': new_name,
1114
'_new_parent': self._new_parent,
1115
'_new_executability': new_executability,
1116
'_new_id': self._new_id,
1117
'_tree_path_ids': tree_path_ids,
1118
'_removed_id': list(self._removed_id),
1119
'_removed_contents': list(self._removed_contents),
1120
'_non_present_ids': self._non_present_ids,
1122
yield serializer.bytes_record(bencode.bencode(attribs),
1124
for trans_id, kind in viewitems(self._new_contents):
1126
lines = osutils.chunks_to_lines(
1127
self._read_file_chunks(trans_id))
1128
parents = self._get_parents_lines(trans_id)
1129
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1130
content = ''.join(mpdiff.to_patch())
1131
if kind == 'directory':
1133
if kind == 'symlink':
1134
content = self._read_symlink_target(trans_id)
1135
yield serializer.bytes_record(content, ((trans_id, kind),))
1137
def deserialize(self, records):
1138
"""Deserialize a stored TreeTransform.
1140
:param records: An iterable of (names, content) tuples, as per
1141
pack.ContainerPushParser.
1143
names, content = next(records)
1144
attribs = bencode.bdecode(content)
1145
self._id_number = attribs['_id_number']
1146
self._new_name = dict((k, v.decode('utf-8'))
1147
for k, v in viewitems(attribs['_new_name']))
1148
self._new_parent = attribs['_new_parent']
1149
self._new_executability = dict((k, bool(v))
1150
for k, v in viewitems(attribs['_new_executability']))
1151
self._new_id = attribs['_new_id']
1152
self._r_new_id = dict((v, k) for k, v in viewitems(self._new_id))
1153
self._tree_path_ids = {}
1154
self._tree_id_paths = {}
1155
for bytepath, trans_id in viewitems(attribs['_tree_path_ids']):
1156
path = bytepath.decode('utf-8')
1157
self._tree_path_ids[path] = trans_id
1158
self._tree_id_paths[trans_id] = path
1159
self._removed_id = set(attribs['_removed_id'])
1160
self._removed_contents = set(attribs['_removed_contents'])
1161
self._non_present_ids = attribs['_non_present_ids']
1162
for ((trans_id, kind),), content in records:
1164
mpdiff = multiparent.MultiParent.from_patch(content)
1165
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1166
self.create_file(lines, trans_id)
1167
if kind == 'directory':
1168
self.create_directory(trans_id)
1169
if kind == 'symlink':
1170
self.create_symlink(content.decode('utf-8'), trans_id)
1173
class DiskTreeTransform(TreeTransformBase):
1174
"""Tree transform storing its contents on disk."""
1176
def __init__(self, tree, limbodir, pb=None,
1177
case_sensitive=True):
1179
:param tree: The tree that will be transformed, but not necessarily
1181
:param limbodir: A directory where new files can be stored until
1182
they are installed in their proper places
1184
:param case_sensitive: If True, the target of the transform is
1185
case sensitive, not just case preserving.
1187
TreeTransformBase.__init__(self, tree, pb, case_sensitive)
1188
self._limbodir = limbodir
1189
self._deletiondir = None
1190
# A mapping of transform ids to their limbo filename
1191
self._limbo_files = {}
1192
self._possibly_stale_limbo_files = set()
1193
# A mapping of transform ids to a set of the transform ids of children
1194
# that their limbo directory has
1195
self._limbo_children = {}
1196
# Map transform ids to maps of child filename to child transform id
1197
self._limbo_children_names = {}
1198
# List of transform ids that need to be renamed from limbo into place
1199
self._needs_rename = set()
1200
self._creation_mtime = None
1203
"""Release the working tree lock, if held, clean up limbo dir.
1205
This is required if apply has not been invoked, but can be invoked
1208
if self._tree is None:
1211
limbo_paths = list(viewvalues(self._limbo_files))
1212
limbo_paths.extend(self._possibly_stale_limbo_files)
1213
limbo_paths.sort(reverse=True)
1214
for path in limbo_paths:
1217
except OSError as e:
1218
if e.errno != errno.ENOENT:
1220
# XXX: warn? perhaps we just got interrupted at an
1221
# inconvenient moment, but perhaps files are disappearing
1224
delete_any(self._limbodir)
1226
# We don't especially care *why* the dir is immortal.
1227
raise ImmortalLimbo(self._limbodir)
1229
if self._deletiondir is not None:
1230
delete_any(self._deletiondir)
1232
raise errors.ImmortalPendingDeletion(self._deletiondir)
1234
TreeTransformBase.finalize(self)
1236
def _limbo_supports_executable(self):
1237
"""Check if the limbo path supports the executable bit."""
1238
# FIXME: Check actual file system capabilities of limbodir
1239
return osutils.supports_executable()
1241
def _limbo_name(self, trans_id):
1242
"""Generate the limbo name of a file"""
1243
limbo_name = self._limbo_files.get(trans_id)
1244
if limbo_name is None:
1245
limbo_name = self._generate_limbo_path(trans_id)
1246
self._limbo_files[trans_id] = limbo_name
1249
def _generate_limbo_path(self, trans_id):
1250
"""Generate a limbo path using the trans_id as the relative path.
1252
This is suitable as a fallback, and when the transform should not be
1253
sensitive to the path encoding of the limbo directory.
1255
self._needs_rename.add(trans_id)
1256
return pathjoin(self._limbodir, trans_id)
1258
def adjust_path(self, name, parent, trans_id):
1259
previous_parent = self._new_parent.get(trans_id)
1260
previous_name = self._new_name.get(trans_id)
1261
TreeTransformBase.adjust_path(self, name, parent, trans_id)
1262
if (trans_id in self._limbo_files and
1263
trans_id not in self._needs_rename):
1264
self._rename_in_limbo([trans_id])
1265
if previous_parent != parent:
1266
self._limbo_children[previous_parent].remove(trans_id)
1267
if previous_parent != parent or previous_name != name:
1268
del self._limbo_children_names[previous_parent][previous_name]
1270
def _rename_in_limbo(self, trans_ids):
1271
"""Fix limbo names so that the right final path is produced.
1273
This means we outsmarted ourselves-- we tried to avoid renaming
1274
these files later by creating them with their final names in their
1275
final parents. But now the previous name or parent is no longer
1276
suitable, so we have to rename them.
1278
Even for trans_ids that have no new contents, we must remove their
1279
entries from _limbo_files, because they are now stale.
1281
for trans_id in trans_ids:
1282
old_path = self._limbo_files[trans_id]
1283
self._possibly_stale_limbo_files.add(old_path)
1284
del self._limbo_files[trans_id]
1285
if trans_id not in self._new_contents:
1287
new_path = self._limbo_name(trans_id)
1288
os.rename(old_path, new_path)
1289
self._possibly_stale_limbo_files.remove(old_path)
1290
for descendant in self._limbo_descendants(trans_id):
1291
desc_path = self._limbo_files[descendant]
1292
desc_path = new_path + desc_path[len(old_path):]
1293
self._limbo_files[descendant] = desc_path
1295
def _limbo_descendants(self, trans_id):
1296
"""Return the set of trans_ids whose limbo paths descend from this."""
1297
descendants = set(self._limbo_children.get(trans_id, []))
1298
for descendant in list(descendants):
1299
descendants.update(self._limbo_descendants(descendant))
1302
def create_file(self, contents, trans_id, mode_id=None, sha1=None):
1303
"""Schedule creation of a new file.
1307
:param contents: an iterator of strings, all of which will be written
1308
to the target destination.
1309
:param trans_id: TreeTransform handle
1310
:param mode_id: If not None, force the mode of the target file to match
1311
the mode of the object referenced by mode_id.
1312
Otherwise, we will try to preserve mode bits of an existing file.
1313
:param sha1: If the sha1 of this content is already known, pass it in.
1314
We can use it to prevent future sha1 computations.
1316
name = self._limbo_name(trans_id)
1317
f = open(name, 'wb')
1319
unique_add(self._new_contents, trans_id, 'file')
1320
f.writelines(contents)
1323
self._set_mtime(name)
1324
self._set_mode(trans_id, mode_id, S_ISREG)
1325
# It is unfortunate we have to use lstat instead of fstat, but we just
1326
# used utime and chmod on the file, so we need the accurate final
1328
if sha1 is not None:
1329
self._observed_sha1s[trans_id] = (sha1, osutils.lstat(name))
1331
def _read_file_chunks(self, trans_id):
1332
cur_file = open(self._limbo_name(trans_id), 'rb')
1334
return cur_file.readlines()
1338
def _read_symlink_target(self, trans_id):
1339
return os.readlink(self._limbo_name(trans_id))
1341
def _set_mtime(self, path):
1342
"""All files that are created get the same mtime.
1344
This time is set by the first object to be created.
1346
if self._creation_mtime is None:
1347
self._creation_mtime = time.time()
1348
os.utime(path, (self._creation_mtime, self._creation_mtime))
1350
def create_hardlink(self, path, trans_id):
1351
"""Schedule creation of a hard link"""
1352
name = self._limbo_name(trans_id)
1355
except OSError as e:
1356
if e.errno != errno.EPERM:
1358
raise errors.HardLinkNotSupported(path)
1360
unique_add(self._new_contents, trans_id, 'file')
1362
# Clean up the file, it never got registered so
1363
# TreeTransform.finalize() won't clean it up.
1367
def create_directory(self, trans_id):
1368
"""Schedule creation of a new directory.
1370
See also new_directory.
1372
os.mkdir(self._limbo_name(trans_id))
1373
unique_add(self._new_contents, trans_id, 'directory')
1375
def create_symlink(self, target, trans_id):
1376
"""Schedule creation of a new symbolic link.
1378
target is a bytestring.
1379
See also new_symlink.
1382
os.symlink(target, self._limbo_name(trans_id))
1383
unique_add(self._new_contents, trans_id, 'symlink')
1386
path = FinalPaths(self).get_path(trans_id)
1389
raise UnableCreateSymlink(path=path)
1391
def cancel_creation(self, trans_id):
1392
"""Cancel the creation of new file contents."""
1393
del self._new_contents[trans_id]
1394
if trans_id in self._observed_sha1s:
1395
del self._observed_sha1s[trans_id]
1396
children = self._limbo_children.get(trans_id)
1397
# if this is a limbo directory with children, move them before removing
1399
if children is not None:
1400
self._rename_in_limbo(children)
1401
del self._limbo_children[trans_id]
1402
del self._limbo_children_names[trans_id]
1403
delete_any(self._limbo_name(trans_id))
1405
def new_orphan(self, trans_id, parent_id):
1406
conf = self._tree.get_config_stack()
1407
handle_orphan = conf.get('bzr.transform.orphan_policy')
1408
handle_orphan(self, trans_id, parent_id)
1411
class OrphaningError(errors.BzrError):
1413
# Only bugs could lead to such exception being seen by the user
1414
internal_error = True
1415
_fmt = "Error while orphaning %s in %s directory"
1417
def __init__(self, orphan, parent):
1418
errors.BzrError.__init__(self)
1419
self.orphan = orphan
1420
self.parent = parent
1423
class OrphaningForbidden(OrphaningError):
1425
_fmt = "Policy: %s doesn't allow creating orphans."
1427
def __init__(self, policy):
1428
errors.BzrError.__init__(self)
1429
self.policy = policy
1432
def move_orphan(tt, orphan_id, parent_id):
1433
"""See TreeTransformBase.new_orphan.
1435
This creates a new orphan in the `brz-orphans` dir at the root of the
1438
:param tt: The TreeTransform orphaning `trans_id`.
1440
:param orphan_id: The trans id that should be orphaned.
1442
:param parent_id: The orphan parent trans id.
1444
# Add the orphan dir if it doesn't exist
1445
orphan_dir_basename = 'brz-orphans'
1446
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1447
if tt.final_kind(od_id) is None:
1448
tt.create_directory(od_id)
1449
parent_path = tt._tree_id_paths[parent_id]
1450
# Find a name that doesn't exist yet in the orphan dir
1451
actual_name = tt.final_name(orphan_id)
1452
new_name = tt._available_backup_name(actual_name, od_id)
1453
tt.adjust_path(new_name, od_id, orphan_id)
1454
trace.warning('%s has been orphaned in %s'
1455
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1458
def refuse_orphan(tt, orphan_id, parent_id):
1459
"""See TreeTransformBase.new_orphan.
1461
This refuses to create orphan, letting the caller handle the conflict.
1463
raise OrphaningForbidden('never')
1466
orphaning_registry = registry.Registry()
1467
orphaning_registry.register(
1468
'conflict', refuse_orphan,
1469
'Leave orphans in place and create a conflict on the directory.')
1470
orphaning_registry.register(
1471
'move', move_orphan,
1472
'Move orphans into the brz-orphans directory.')
1473
orphaning_registry._set_default_key('conflict')
1476
opt_transform_orphan = _mod_config.RegistryOption(
1477
'bzr.transform.orphan_policy', orphaning_registry,
1478
help='Policy for orphaned files during transform operations.',
1482
class TreeTransform(DiskTreeTransform):
1483
"""Represent a tree transformation.
1485
This object is designed to support incremental generation of the transform,
1488
However, it gives optimum performance when parent directories are created
1489
before their contents. The transform is then able to put child files
1490
directly in their parent directory, avoiding later renames.
1492
It is easy to produce malformed transforms, but they are generally
1493
harmless. Attempting to apply a malformed transform will cause an
1494
exception to be raised before any modifications are made to the tree.
1496
Many kinds of malformed transforms can be corrected with the
1497
resolve_conflicts function. The remaining ones indicate programming error,
1498
such as trying to create a file with no path.
1500
Two sets of file creation methods are supplied. Convenience methods are:
1505
These are composed of the low-level methods:
1507
* create_file or create_directory or create_symlink
1511
Transform/Transaction ids
1512
-------------------------
1513
trans_ids are temporary ids assigned to all files involved in a transform.
1514
It's possible, even common, that not all files in the Tree have trans_ids.
1516
trans_ids are used because filenames and file_ids are not good enough
1517
identifiers; filenames change, and not all files have file_ids. File-ids
1518
are also associated with trans-ids, so that moving a file moves its
1521
trans_ids are only valid for the TreeTransform that generated them.
1525
Limbo is a temporary directory use to hold new versions of files.
1526
Files are added to limbo by create_file, create_directory, create_symlink,
1527
and their convenience variants (new_*). Files may be removed from limbo
1528
using cancel_creation. Files are renamed from limbo into their final
1529
location as part of TreeTransform.apply
1531
Limbo must be cleaned up, by either calling TreeTransform.apply or
1532
calling TreeTransform.finalize.
1534
Files are placed into limbo inside their parent directories, where
1535
possible. This reduces subsequent renames, and makes operations involving
1536
lots of files faster. This optimization is only possible if the parent
1537
directory is created *before* creating any of its children, so avoid
1538
creating children before parents, where possible.
1542
This temporary directory is used by _FileMover for storing files that are
1543
about to be deleted. In case of rollback, the files will be restored.
1544
FileMover does not delete files until it is sure that a rollback will not
1547
def __init__(self, tree, pb=None):
1548
"""Note: a tree_write lock is taken on the tree.
1550
Use TreeTransform.finalize() to release the lock (can be omitted if
1551
TreeTransform.apply() called).
1553
tree.lock_tree_write()
1556
limbodir = urlutils.local_path_from_url(
1557
tree._transport.abspath('limbo'))
1558
osutils.ensure_empty_directory_exists(
1560
errors.ExistingLimbo)
1561
deletiondir = urlutils.local_path_from_url(
1562
tree._transport.abspath('pending-deletion'))
1563
osutils.ensure_empty_directory_exists(
1565
errors.ExistingPendingDeletion)
1570
# Cache of realpath results, to speed up canonical_path
1571
self._realpaths = {}
1572
# Cache of relpath results, to speed up canonical_path
1574
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1575
tree.case_sensitive)
1576
self._deletiondir = deletiondir
1578
def canonical_path(self, path):
1579
"""Get the canonical tree-relative path"""
1580
# don't follow final symlinks
1581
abs = self._tree.abspath(path)
1582
if abs in self._relpaths:
1583
return self._relpaths[abs]
1584
dirname, basename = os.path.split(abs)
1585
if dirname not in self._realpaths:
1586
self._realpaths[dirname] = os.path.realpath(dirname)
1587
dirname = self._realpaths[dirname]
1588
abs = pathjoin(dirname, basename)
1589
if dirname in self._relpaths:
1590
relpath = pathjoin(self._relpaths[dirname], basename)
1591
relpath = relpath.rstrip('/\\')
1593
relpath = self._tree.relpath(abs)
1594
self._relpaths[abs] = relpath
1597
def tree_kind(self, trans_id):
1598
"""Determine the file kind in the working tree.
1600
:returns: The file kind or None if the file does not exist
1602
path = self._tree_id_paths.get(trans_id)
1606
return file_kind(self._tree.abspath(path))
1607
except errors.NoSuchFile:
1610
def _set_mode(self, trans_id, mode_id, typefunc):
1611
"""Set the mode of new file contents.
1612
The mode_id is the existing file to get the mode from (often the same
1613
as trans_id). The operation is only performed if there's a mode match
1614
according to typefunc.
1619
old_path = self._tree_id_paths[mode_id]
1623
mode = os.stat(self._tree.abspath(old_path)).st_mode
1624
except OSError as e:
1625
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1626
# Either old_path doesn't exist, or the parent of the
1627
# target is not a directory (but will be one eventually)
1628
# Either way, we know it doesn't exist *right now*
1629
# See also bug #248448
1634
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1636
def iter_tree_children(self, parent_id):
1637
"""Iterate through the entry's tree children, if any"""
1639
path = self._tree_id_paths[parent_id]
1643
children = os.listdir(self._tree.abspath(path))
1644
except OSError as e:
1645
if not (osutils._is_error_enotdir(e)
1646
or e.errno in (errno.ENOENT, errno.ESRCH)):
1650
for child in children:
1651
childpath = joinpath(path, child)
1652
if self._tree.is_control_filename(childpath):
1654
yield self.trans_id_tree_path(childpath)
1656
def _generate_limbo_path(self, trans_id):
1657
"""Generate a limbo path using the final path if possible.
1659
This optimizes the performance of applying the tree transform by
1660
avoiding renames. These renames can be avoided only when the parent
1661
directory is already scheduled for creation.
1663
If the final path cannot be used, falls back to using the trans_id as
1666
parent = self._new_parent.get(trans_id)
1667
# if the parent directory is already in limbo (e.g. when building a
1668
# tree), choose a limbo name inside the parent, to reduce further
1670
use_direct_path = False
1671
if self._new_contents.get(parent) == 'directory':
1672
filename = self._new_name.get(trans_id)
1673
if filename is not None:
1674
if parent not in self._limbo_children:
1675
self._limbo_children[parent] = set()
1676
self._limbo_children_names[parent] = {}
1677
use_direct_path = True
1678
# the direct path can only be used if no other file has
1679
# already taken this pathname, i.e. if the name is unused, or
1680
# if it is already associated with this trans_id.
1681
elif self._case_sensitive_target:
1682
if (self._limbo_children_names[parent].get(filename)
1683
in (trans_id, None)):
1684
use_direct_path = True
1686
for l_filename, l_trans_id in viewitems(
1687
self._limbo_children_names[parent]):
1688
if l_trans_id == trans_id:
1690
if l_filename.lower() == filename.lower():
1693
use_direct_path = True
1695
if not use_direct_path:
1696
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1698
limbo_name = pathjoin(self._limbo_files[parent], filename)
1699
self._limbo_children[parent].add(trans_id)
1700
self._limbo_children_names[parent][filename] = trans_id
1704
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1705
"""Apply all changes to the inventory and filesystem.
1707
If filesystem or inventory conflicts are present, MalformedTransform
1710
If apply succeeds, finalize is not necessary.
1712
:param no_conflicts: if True, the caller guarantees there are no
1713
conflicts, so no check is made.
1714
:param precomputed_delta: An inventory delta to use instead of
1716
:param _mover: Supply an alternate FileMover, for testing
1718
for hook in MutableTree.hooks['pre_transform']:
1719
hook(self._tree, self)
1720
if not no_conflicts:
1721
self._check_malformed()
1722
child_pb = ui.ui_factory.nested_progress_bar()
1724
if precomputed_delta is None:
1725
child_pb.update(gettext('Apply phase'), 0, 2)
1726
inventory_delta = self._generate_inventory_delta()
1729
inventory_delta = precomputed_delta
1732
mover = _FileMover()
1736
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1737
self._apply_removals(mover)
1738
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1739
modified_paths = self._apply_insertions(mover)
1744
mover.apply_deletions()
1747
if self.final_file_id(self.root) is None:
1748
inventory_delta = [e for e in inventory_delta if e[0] != '']
1749
self._tree.apply_inventory_delta(inventory_delta)
1750
self._apply_observed_sha1s()
1753
return _TransformResults(modified_paths, self.rename_count)
1755
def _generate_inventory_delta(self):
1756
"""Generate an inventory delta for the current transform."""
1757
inventory_delta = []
1758
child_pb = ui.ui_factory.nested_progress_bar()
1759
new_paths = self._inventory_altered()
1760
total_entries = len(new_paths) + len(self._removed_id)
1762
for num, trans_id in enumerate(self._removed_id):
1764
child_pb.update(gettext('removing file'), num, total_entries)
1765
if trans_id == self._new_root:
1766
file_id = self._tree.get_root_id()
1768
file_id = self.tree_file_id(trans_id)
1769
# File-id isn't really being deleted, just moved
1770
if file_id in self._r_new_id:
1772
path = self._tree_id_paths[trans_id]
1773
inventory_delta.append((path, None, file_id, None))
1774
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1776
entries = self._tree.iter_entries_by_dir(
1777
viewvalues(new_path_file_ids))
1778
old_paths = dict((e.file_id, p) for p, e in entries)
1780
for num, (path, trans_id) in enumerate(new_paths):
1782
child_pb.update(gettext('adding file'),
1783
num + len(self._removed_id), total_entries)
1784
file_id = new_path_file_ids[trans_id]
1788
kind = self.final_kind(trans_id)
1790
kind = self._tree.stored_kind(file_id)
1791
parent_trans_id = self.final_parent(trans_id)
1792
parent_file_id = new_path_file_ids.get(parent_trans_id)
1793
if parent_file_id is None:
1794
parent_file_id = self.final_file_id(parent_trans_id)
1795
if trans_id in self._new_reference_revision:
1796
new_entry = inventory.TreeReference(
1798
self._new_name[trans_id],
1799
self.final_file_id(self._new_parent[trans_id]),
1800
None, self._new_reference_revision[trans_id])
1802
new_entry = inventory.make_entry(kind,
1803
self.final_name(trans_id),
1804
parent_file_id, file_id)
1805
old_path = old_paths.get(new_entry.file_id)
1806
new_executability = self._new_executability.get(trans_id)
1807
if new_executability is not None:
1808
new_entry.executable = new_executability
1809
inventory_delta.append(
1810
(old_path, path, new_entry.file_id, new_entry))
1813
return inventory_delta
1815
def _apply_removals(self, mover):
1816
"""Perform tree operations that remove directory/inventory names.
1818
That is, delete files that are to be deleted, and put any files that
1819
need renaming into limbo. This must be done in strict child-to-parent
1822
If inventory_delta is None, no inventory delta generation is performed.
1824
tree_paths = sorted(viewitems(self._tree_path_ids), reverse=True)
1825
child_pb = ui.ui_factory.nested_progress_bar()
1827
for num, (path, trans_id) in enumerate(tree_paths):
1828
# do not attempt to move root into a subdirectory of itself.
1831
child_pb.update(gettext('removing file'), num, len(tree_paths))
1832
full_path = self._tree.abspath(path)
1833
if trans_id in self._removed_contents:
1834
delete_path = os.path.join(self._deletiondir, trans_id)
1835
mover.pre_delete(full_path, delete_path)
1836
elif (trans_id in self._new_name
1837
or trans_id in self._new_parent):
1839
mover.rename(full_path, self._limbo_name(trans_id))
1840
except errors.TransformRenameFailed as e:
1841
if e.errno != errno.ENOENT:
1844
self.rename_count += 1
1848
def _apply_insertions(self, mover):
1849
"""Perform tree operations that insert directory/inventory names.
1851
That is, create any files that need to be created, and restore from
1852
limbo any files that needed renaming. This must be done in strict
1853
parent-to-child order.
1855
If inventory_delta is None, no inventory delta is calculated, and
1856
no list of modified paths is returned.
1858
new_paths = self.new_paths(filesystem_only=True)
1860
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1862
child_pb = ui.ui_factory.nested_progress_bar()
1864
for num, (path, trans_id) in enumerate(new_paths):
1866
child_pb.update(gettext('adding file'), num, len(new_paths))
1867
full_path = self._tree.abspath(path)
1868
if trans_id in self._needs_rename:
1870
mover.rename(self._limbo_name(trans_id), full_path)
1871
except errors.TransformRenameFailed as e:
1872
# We may be renaming a dangling inventory id
1873
if e.errno != errno.ENOENT:
1876
self.rename_count += 1
1877
# TODO: if trans_id in self._observed_sha1s, we should
1878
# re-stat the final target, since ctime will be
1879
# updated by the change.
1880
if (trans_id in self._new_contents or
1881
self.path_changed(trans_id)):
1882
if trans_id in self._new_contents:
1883
modified_paths.append(full_path)
1884
if trans_id in self._new_executability:
1885
self._set_executability(path, trans_id)
1886
if trans_id in self._observed_sha1s:
1887
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1888
st = osutils.lstat(full_path)
1889
self._observed_sha1s[trans_id] = (o_sha1, st)
1892
for path, trans_id in new_paths:
1893
# new_paths includes stuff like workingtree conflicts. Only the
1894
# stuff in new_contents actually comes from limbo.
1895
if trans_id in self._limbo_files:
1896
del self._limbo_files[trans_id]
1897
self._new_contents.clear()
1898
return modified_paths
1900
def _apply_observed_sha1s(self):
1901
"""After we have finished renaming everything, update observed sha1s
1903
This has to be done after self._tree.apply_inventory_delta, otherwise
1904
it doesn't know anything about the files we are updating. Also, we want
1905
to do this as late as possible, so that most entries end up cached.
1907
# TODO: this doesn't update the stat information for directories. So
1908
# the first 'bzr status' will still need to rewrite
1909
# .bzr/checkout/dirstate. However, we at least don't need to
1910
# re-read all of the files.
1911
# TODO: If the operation took a while, we could do a time.sleep(3) here
1912
# to allow the clock to tick over and ensure we won't have any
1913
# problems. (we could observe start time, and finish time, and if
1914
# it is less than eg 10% overhead, add a sleep call.)
1915
paths = FinalPaths(self)
1916
for trans_id, observed in viewitems(self._observed_sha1s):
1917
path = paths.get_path(trans_id)
1918
# We could get the file_id, but dirstate prefers to use the path
1919
# anyway, and it is 'cheaper' to determine.
1920
# file_id = self._new_id[trans_id]
1921
self._tree._observed_sha1(None, path, observed)
1924
class TransformPreview(DiskTreeTransform):
1925
"""A TreeTransform for generating preview trees.
1927
Unlike TreeTransform, this version works when the input tree is a
1928
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1929
unversioned files in the input tree.
1932
def __init__(self, tree, pb=None, case_sensitive=True):
1934
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1935
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1937
def canonical_path(self, path):
1940
def tree_kind(self, trans_id):
1941
path = self._tree_id_paths.get(trans_id)
1944
kind = self._tree.path_content_summary(path)[0]
1945
if kind == 'missing':
1949
def _set_mode(self, trans_id, mode_id, typefunc):
1950
"""Set the mode of new file contents.
1951
The mode_id is the existing file to get the mode from (often the same
1952
as trans_id). The operation is only performed if there's a mode match
1953
according to typefunc.
1955
# is it ok to ignore this? probably
1958
def iter_tree_children(self, parent_id):
1959
"""Iterate through the entry's tree children, if any"""
1961
path = self._tree_id_paths[parent_id]
1964
file_id = self.tree_file_id(parent_id)
1967
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1968
children = getattr(entry, 'children', {})
1969
for child in children:
1970
childpath = joinpath(path, child)
1971
yield self.trans_id_tree_path(childpath)
1973
def new_orphan(self, trans_id, parent_id):
1974
raise NotImplementedError(self.new_orphan)
1977
class _PreviewTree(inventorytree.InventoryTree):
1978
"""Partial implementation of Tree to support show_diff_trees"""
1980
def __init__(self, transform):
1981
self._transform = transform
1982
self._final_paths = FinalPaths(transform)
1983
self.__by_parent = None
1984
self._parent_ids = []
1985
self._all_children_cache = {}
1986
self._path2trans_id_cache = {}
1987
self._final_name_cache = {}
1988
self._iter_changes_cache = dict((c[0], c) for c in
1989
self._transform.iter_changes())
1991
def _content_change(self, file_id):
1992
"""Return True if the content of this file changed"""
1993
changes = self._iter_changes_cache.get(file_id)
1994
# changes[2] is true if the file content changed. See
1995
# InterTree.iter_changes.
1996
return (changes is not None and changes[2])
1998
def _get_repository(self):
1999
repo = getattr(self._transform._tree, '_repository', None)
2001
repo = self._transform._tree.branch.repository
2004
def _iter_parent_trees(self):
2005
for revision_id in self.get_parent_ids():
2007
yield self.revision_tree(revision_id)
2008
except errors.NoSuchRevisionInTree:
2009
yield self._get_repository().revision_tree(revision_id)
2011
def _get_file_revision(self, file_id, vf, tree_revision):
2012
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2013
self._iter_parent_trees()]
2014
vf.add_lines((file_id, tree_revision), parent_keys,
2015
self.get_file_lines(file_id))
2016
repo = self._get_repository()
2017
base_vf = repo.texts
2018
if base_vf not in vf.fallback_versionedfiles:
2019
vf.fallback_versionedfiles.append(base_vf)
2020
return tree_revision
2022
def _stat_limbo_file(self, file_id=None, trans_id=None):
2023
if trans_id is None:
2024
trans_id = self._transform.trans_id_file_id(file_id)
2025
name = self._transform._limbo_name(trans_id)
2026
return os.lstat(name)
2029
def _by_parent(self):
2030
if self.__by_parent is None:
2031
self.__by_parent = self._transform.by_parent()
2032
return self.__by_parent
2034
def _comparison_data(self, entry, path):
2035
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2036
if kind == 'missing':
2040
file_id = self._transform.final_file_id(self._path2trans_id(path))
2041
executable = self.is_executable(file_id, path)
2042
return kind, executable, None
2044
def is_locked(self):
2047
def lock_read(self):
2048
# Perhaps in theory, this should lock the TreeTransform?
2055
def root_inventory(self):
2056
"""This Tree does not use inventory as its backing data."""
2057
raise NotImplementedError(_PreviewTree.root_inventory)
2059
def get_root_id(self):
2060
return self._transform.final_file_id(self._transform.root)
2062
def all_file_ids(self):
2063
tree_ids = set(self._transform._tree.all_file_ids())
2064
tree_ids.difference_update(self._transform.tree_file_id(t)
2065
for t in self._transform._removed_id)
2066
tree_ids.update(viewvalues(self._transform._new_id))
2070
return iter(self.all_file_ids())
2072
def _has_id(self, file_id, fallback_check):
2073
if file_id in self._transform._r_new_id:
2075
elif file_id in {self._transform.tree_file_id(trans_id) for
2076
trans_id in self._transform._removed_id}:
2079
return fallback_check(file_id)
2081
def has_id(self, file_id):
2082
return self._has_id(file_id, self._transform._tree.has_id)
2084
def has_or_had_id(self, file_id):
2085
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2087
def _path2trans_id(self, path):
2088
# We must not use None here, because that is a valid value to store.
2089
trans_id = self._path2trans_id_cache.get(path, object)
2090
if trans_id is not object:
2092
segments = splitpath(path)
2093
cur_parent = self._transform.root
2094
for cur_segment in segments:
2095
for child in self._all_children(cur_parent):
2096
final_name = self._final_name_cache.get(child)
2097
if final_name is None:
2098
final_name = self._transform.final_name(child)
2099
self._final_name_cache[child] = final_name
2100
if final_name == cur_segment:
2104
self._path2trans_id_cache[path] = None
2106
self._path2trans_id_cache[path] = cur_parent
2109
def path2id(self, path):
2110
if isinstance(path, list):
2113
path = osutils.pathjoin(*path)
2114
return self._transform.final_file_id(self._path2trans_id(path))
2116
def id2path(self, file_id):
2117
trans_id = self._transform.trans_id_file_id(file_id)
2119
return self._final_paths._determine_path(trans_id)
2121
raise errors.NoSuchId(self, file_id)
2123
def _all_children(self, trans_id):
2124
children = self._all_children_cache.get(trans_id)
2125
if children is not None:
2127
children = set(self._transform.iter_tree_children(trans_id))
2128
# children in the _new_parent set are provided by _by_parent.
2129
children.difference_update(self._transform._new_parent)
2130
children.update(self._by_parent.get(trans_id, []))
2131
self._all_children_cache[trans_id] = children
2134
def iter_children(self, file_id):
2135
trans_id = self._transform.trans_id_file_id(file_id)
2136
for child_trans_id in self._all_children(trans_id):
2137
yield self._transform.final_file_id(child_trans_id)
2140
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2141
in self._transform._tree.extras())
2142
possible_extras.update(self._transform._new_contents)
2143
possible_extras.update(self._transform._removed_id)
2144
for trans_id in possible_extras:
2145
if self._transform.final_file_id(trans_id) is None:
2146
yield self._final_paths._determine_path(trans_id)
2148
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2149
yield_parents=False):
2150
for trans_id, parent_file_id in ordered_entries:
2151
file_id = self._transform.final_file_id(trans_id)
2154
if (specific_file_ids is not None
2155
and file_id not in specific_file_ids):
2157
kind = self._transform.final_kind(trans_id)
2159
kind = self._transform._tree.stored_kind(file_id)
2160
new_entry = inventory.make_entry(
2162
self._transform.final_name(trans_id),
2163
parent_file_id, file_id)
2164
yield new_entry, trans_id
2166
def _list_files_by_dir(self):
2167
todo = [ROOT_PARENT]
2169
while len(todo) > 0:
2171
parent_file_id = self._transform.final_file_id(parent)
2172
children = list(self._all_children(parent))
2173
paths = dict(zip(children, self._final_paths.get_paths(children)))
2174
children.sort(key=paths.get)
2175
todo.extend(reversed(children))
2176
for trans_id in children:
2177
ordered_ids.append((trans_id, parent_file_id))
2180
def iter_child_entries(self, file_id, path=None):
2181
self.id2path(file_id)
2182
trans_id = self._transform.trans_id_file_id(file_id)
2183
todo = [(child_trans_id, trans_id) for child_trans_id in
2184
self._all_children(trans_id)]
2185
for entry, trans_id in self._make_inv_entries(todo):
2188
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2189
# This may not be a maximally efficient implementation, but it is
2190
# reasonably straightforward. An implementation that grafts the
2191
# TreeTransform changes onto the tree's iter_entries_by_dir results
2192
# might be more efficient, but requires tricky inferences about stack
2194
ordered_ids = self._list_files_by_dir()
2195
for entry, trans_id in self._make_inv_entries(ordered_ids,
2196
specific_file_ids, yield_parents=yield_parents):
2197
yield unicode(self._final_paths.get_path(trans_id)), entry
2199
def _iter_entries_for_dir(self, dir_path):
2200
"""Return path, entry for items in a directory without recursing down."""
2201
dir_file_id = self.path2id(dir_path)
2203
for file_id in self.iter_children(dir_file_id):
2204
trans_id = self._transform.trans_id_file_id(file_id)
2205
ordered_ids.append((trans_id, file_id))
2206
for entry, trans_id in self._make_inv_entries(ordered_ids):
2207
yield unicode(self._final_paths.get_path(trans_id)), entry
2209
def list_files(self, include_root=False, from_dir=None, recursive=True):
2210
"""See WorkingTree.list_files."""
2211
# XXX This should behave like WorkingTree.list_files, but is really
2212
# more like RevisionTree.list_files.
2216
prefix = from_dir + '/'
2217
entries = self.iter_entries_by_dir()
2218
for path, entry in entries:
2219
if entry.name == '' and not include_root:
2222
if not path.startswith(prefix):
2224
path = path[len(prefix):]
2225
yield path, 'V', entry.kind, entry.file_id, entry
2227
if from_dir is None and include_root is True:
2228
root_entry = inventory.make_entry('directory', '',
2229
ROOT_PARENT, self.get_root_id())
2230
yield '', 'V', 'directory', root_entry.file_id, root_entry
2231
entries = self._iter_entries_for_dir(from_dir or '')
2232
for path, entry in entries:
2233
yield path, 'V', entry.kind, entry.file_id, entry
2235
def kind(self, file_id):
2236
trans_id = self._transform.trans_id_file_id(file_id)
2237
return self._transform.final_kind(trans_id)
2239
def stored_kind(self, file_id):
2240
trans_id = self._transform.trans_id_file_id(file_id)
2242
return self._transform._new_contents[trans_id]
2244
return self._transform._tree.stored_kind(file_id)
2246
def get_file_mtime(self, file_id, path=None):
2247
"""See Tree.get_file_mtime"""
2248
if not self._content_change(file_id):
2249
return self._transform._tree.get_file_mtime(file_id)
2250
return self._stat_limbo_file(file_id).st_mtime
2252
def _file_size(self, entry, stat_value):
2253
return self.get_file_size(entry.file_id)
2255
def get_file_size(self, file_id):
2256
"""See Tree.get_file_size"""
2257
trans_id = self._transform.trans_id_file_id(file_id)
2258
kind = self._transform.final_kind(trans_id)
2261
if trans_id in self._transform._new_contents:
2262
return self._stat_limbo_file(trans_id=trans_id).st_size
2263
if self.kind(file_id) == 'file':
2264
return self._transform._tree.get_file_size(file_id)
2268
def get_file_verifier(self, file_id, path=None, stat_value=None):
2269
trans_id = self._transform.trans_id_file_id(file_id)
2270
kind = self._transform._new_contents.get(trans_id)
2272
return self._transform._tree.get_file_verifier(file_id)
2274
fileobj = self.get_file(file_id)
2276
return ("SHA1", sha_file(fileobj))
2280
def get_file_sha1(self, file_id, path=None, stat_value=None):
2281
trans_id = self._transform.trans_id_file_id(file_id)
2282
kind = self._transform._new_contents.get(trans_id)
2284
return self._transform._tree.get_file_sha1(file_id)
2286
fileobj = self.get_file(file_id)
2288
return sha_file(fileobj)
2292
def is_executable(self, file_id, path=None):
2295
trans_id = self._transform.trans_id_file_id(file_id)
2297
return self._transform._new_executability[trans_id]
2300
return self._transform._tree.is_executable(file_id, path)
2301
except OSError as e:
2302
if e.errno == errno.ENOENT:
2305
except errors.NoSuchId:
2308
def has_filename(self, path):
2309
trans_id = self._path2trans_id(path)
2310
if trans_id in self._transform._new_contents:
2312
elif trans_id in self._transform._removed_contents:
2315
return self._transform._tree.has_filename(path)
2317
def path_content_summary(self, path):
2318
trans_id = self._path2trans_id(path)
2319
tt = self._transform
2320
tree_path = tt._tree_id_paths.get(trans_id)
2321
kind = tt._new_contents.get(trans_id)
2323
if tree_path is None or trans_id in tt._removed_contents:
2324
return 'missing', None, None, None
2325
summary = tt._tree.path_content_summary(tree_path)
2326
kind, size, executable, link_or_sha1 = summary
2329
limbo_name = tt._limbo_name(trans_id)
2330
if trans_id in tt._new_reference_revision:
2331
kind = 'tree-reference'
2333
statval = os.lstat(limbo_name)
2334
size = statval.st_size
2335
if not tt._limbo_supports_executable():
2338
executable = statval.st_mode & S_IEXEC
2342
if kind == 'symlink':
2343
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2344
executable = tt._new_executability.get(trans_id, executable)
2345
return kind, size, executable, link_or_sha1
2347
def iter_changes(self, from_tree, include_unchanged=False,
2348
specific_files=None, pb=None, extra_trees=None,
2349
require_versioned=True, want_unversioned=False):
2350
"""See InterTree.iter_changes.
2352
This has a fast path that is only used when the from_tree matches
2353
the transform tree, and no fancy options are supplied.
2355
if (from_tree is not self._transform._tree or include_unchanged or
2356
specific_files or want_unversioned):
2357
return tree.InterTree(from_tree, self).iter_changes(
2358
include_unchanged=include_unchanged,
2359
specific_files=specific_files,
2361
extra_trees=extra_trees,
2362
require_versioned=require_versioned,
2363
want_unversioned=want_unversioned)
2364
if want_unversioned:
2365
raise ValueError('want_unversioned is not supported')
2366
return self._transform.iter_changes()
2368
def get_file(self, file_id, path=None):
2369
"""See Tree.get_file"""
2370
if not self._content_change(file_id):
2371
return self._transform._tree.get_file(file_id, path)
2372
trans_id = self._transform.trans_id_file_id(file_id)
2373
name = self._transform._limbo_name(trans_id)
2374
return open(name, 'rb')
2376
def get_file_with_stat(self, file_id, path=None):
2377
return self.get_file(file_id, path), None
2379
def annotate_iter(self, file_id,
2380
default_revision=_mod_revision.CURRENT_REVISION):
2381
changes = self._iter_changes_cache.get(file_id)
2385
changed_content, versioned, kind = (changes[2], changes[3],
2389
get_old = (kind[0] == 'file' and versioned[0])
2391
old_annotation = self._transform._tree.annotate_iter(file_id,
2392
default_revision=default_revision)
2396
return old_annotation
2397
if not changed_content:
2398
return old_annotation
2399
# TODO: This is doing something similar to what WT.annotate_iter is
2400
# doing, however it fails slightly because it doesn't know what
2401
# the *other* revision_id is, so it doesn't know how to give the
2402
# other as the origin for some lines, they all get
2403
# 'default_revision'
2404
# It would be nice to be able to use the new Annotator based
2405
# approach, as well.
2406
return annotate.reannotate([old_annotation],
2407
self.get_file(file_id).readlines(),
2410
def get_symlink_target(self, file_id, path=None):
2411
"""See Tree.get_symlink_target"""
2412
if not self._content_change(file_id):
2413
return self._transform._tree.get_symlink_target(file_id)
2414
trans_id = self._transform.trans_id_file_id(file_id)
2415
name = self._transform._limbo_name(trans_id)
2416
return osutils.readlink(name)
2418
def walkdirs(self, prefix=''):
2419
pending = [self._transform.root]
2420
while len(pending) > 0:
2421
parent_id = pending.pop()
2424
prefix = prefix.rstrip('/')
2425
parent_path = self._final_paths.get_path(parent_id)
2426
parent_file_id = self._transform.final_file_id(parent_id)
2427
for child_id in self._all_children(parent_id):
2428
path_from_root = self._final_paths.get_path(child_id)
2429
basename = self._transform.final_name(child_id)
2430
file_id = self._transform.final_file_id(child_id)
2431
kind = self._transform.final_kind(child_id)
2432
if kind is not None:
2433
versioned_kind = kind
2436
versioned_kind = self._transform._tree.stored_kind(file_id)
2437
if versioned_kind == 'directory':
2438
subdirs.append(child_id)
2439
children.append((path_from_root, basename, kind, None,
2440
file_id, versioned_kind))
2442
if parent_path.startswith(prefix):
2443
yield (parent_path, parent_file_id), children
2444
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2447
def get_parent_ids(self):
2448
return self._parent_ids
2450
def set_parent_ids(self, parent_ids):
2451
self._parent_ids = parent_ids
2453
def get_revision_tree(self, revision_id):
2454
return self._transform._tree.get_revision_tree(revision_id)
2457
def joinpath(parent, child):
2458
"""Join tree-relative paths, handling the tree root specially"""
2459
if parent is None or parent == "":
2462
return pathjoin(parent, child)
2465
class FinalPaths(object):
2466
"""Make path calculation cheap by memoizing paths.
2468
The underlying tree must not be manipulated between calls, or else
2469
the results will likely be incorrect.
2471
def __init__(self, transform):
2472
object.__init__(self)
2473
self._known_paths = {}
2474
self.transform = transform
2476
def _determine_path(self, trans_id):
2477
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2479
name = self.transform.final_name(trans_id)
2480
parent_id = self.transform.final_parent(trans_id)
2481
if parent_id == self.transform.root:
2484
return pathjoin(self.get_path(parent_id), name)
2486
def get_path(self, trans_id):
2487
"""Find the final path associated with a trans_id"""
2488
if trans_id not in self._known_paths:
2489
self._known_paths[trans_id] = self._determine_path(trans_id)
2490
return self._known_paths[trans_id]
2492
def get_paths(self, trans_ids):
2493
return [(self.get_path(t), t) for t in trans_ids]
2497
def topology_sorted_ids(tree):
2498
"""Determine the topological order of the ids in a tree"""
2499
file_ids = list(tree)
2500
file_ids.sort(key=tree.id2path)
2504
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2505
delta_from_tree=False):
2506
"""Create working tree for a branch, using a TreeTransform.
2508
This function should be used on empty trees, having a tree root at most.
2509
(see merge and revert functionality for working with existing trees)
2511
Existing files are handled like so:
2513
- Existing bzrdirs take precedence over creating new items. They are
2514
created as '%s.diverted' % name.
2515
- Otherwise, if the content on disk matches the content we are building,
2516
it is silently replaced.
2517
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2519
:param tree: The tree to convert wt into a copy of
2520
:param wt: The working tree that files will be placed into
2521
:param accelerator_tree: A tree which can be used for retrieving file
2522
contents more quickly than tree itself, i.e. a workingtree. tree
2523
will be used for cases where accelerator_tree's content is different.
2524
:param hardlink: If true, hard-link files to accelerator_tree, where
2525
possible. accelerator_tree must implement abspath, i.e. be a
2527
:param delta_from_tree: If true, build_tree may use the input Tree to
2528
generate the inventory delta.
2530
wt.lock_tree_write()
2534
if accelerator_tree is not None:
2535
accelerator_tree.lock_read()
2537
return _build_tree(tree, wt, accelerator_tree, hardlink,
2540
if accelerator_tree is not None:
2541
accelerator_tree.unlock()
2548
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2549
"""See build_tree."""
2550
for num, _unused in enumerate(wt.all_file_ids()):
2551
if num > 0: # more than just a root
2552
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2554
top_pb = ui.ui_factory.nested_progress_bar()
2555
pp = ProgressPhase("Build phase", 2, top_pb)
2556
if tree.get_root_id() is not None:
2557
# This is kind of a hack: we should be altering the root
2558
# as part of the regular tree shape diff logic.
2559
# The conditional test here is to avoid doing an
2560
# expensive operation (flush) every time the root id
2561
# is set within the tree, nor setting the root and thus
2562
# marking the tree as dirty, because we use two different
2563
# idioms here: tree interfaces and inventory interfaces.
2564
if wt.get_root_id() != tree.get_root_id():
2565
wt.set_root_id(tree.get_root_id())
2567
tt = TreeTransform(wt)
2571
file_trans_id[wt.get_root_id()] = \
2572
tt.trans_id_tree_file_id(wt.get_root_id())
2573
pb = ui.ui_factory.nested_progress_bar()
2575
deferred_contents = []
2577
total = len(tree.all_file_ids())
2579
precomputed_delta = []
2581
precomputed_delta = None
2582
# Check if tree inventory has content. If so, we populate
2583
# existing_files with the directory content. If there are no
2584
# entries we skip populating existing_files as its not used.
2585
# This improves performance and unncessary work on large
2586
# directory trees. (#501307)
2588
existing_files = set()
2589
for dir, files in wt.walkdirs():
2590
existing_files.update(f[0] for f in files)
2591
for num, (tree_path, entry) in \
2592
enumerate(tree.iter_entries_by_dir()):
2593
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2594
if entry.parent_id is None:
2597
file_id = entry.file_id
2599
precomputed_delta.append((None, tree_path, file_id, entry))
2600
if tree_path in existing_files:
2601
target_path = wt.abspath(tree_path)
2602
kind = file_kind(target_path)
2603
if kind == "directory":
2605
controldir.ControlDir.open(target_path)
2606
except errors.NotBranchError:
2610
if (file_id not in divert and
2611
_content_match(tree, entry, file_id, kind,
2613
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2614
if kind == 'directory':
2616
parent_id = file_trans_id[entry.parent_id]
2617
if entry.kind == 'file':
2618
# We *almost* replicate new_by_entry, so that we can defer
2619
# getting the file text, and get them all at once.
2620
trans_id = tt.create_path(entry.name, parent_id)
2621
file_trans_id[file_id] = trans_id
2622
tt.version_file(file_id, trans_id)
2623
executable = tree.is_executable(file_id, tree_path)
2625
tt.set_executability(executable, trans_id)
2626
trans_data = (trans_id, tree_path, entry.text_sha1)
2627
deferred_contents.append((file_id, trans_data))
2629
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2632
new_trans_id = file_trans_id[file_id]
2633
old_parent = tt.trans_id_tree_path(tree_path)
2634
_reparent_children(tt, old_parent, new_trans_id)
2635
offset = num + 1 - len(deferred_contents)
2636
_create_files(tt, tree, deferred_contents, pb, offset,
2637
accelerator_tree, hardlink)
2641
divert_trans = set(file_trans_id[f] for f in divert)
2642
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2643
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2644
if len(raw_conflicts) > 0:
2645
precomputed_delta = None
2646
conflicts = cook_conflicts(raw_conflicts, tt)
2647
for conflict in conflicts:
2648
trace.warning(unicode(conflict))
2650
wt.add_conflicts(conflicts)
2651
except errors.UnsupportedOperation:
2653
result = tt.apply(no_conflicts=True,
2654
precomputed_delta=precomputed_delta)
2661
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2663
total = len(desired_files) + offset
2665
if accelerator_tree is None:
2666
new_desired_files = desired_files
2668
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2669
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2670
in iter if not (c or e[0] != e[1])]
2671
if accelerator_tree.supports_content_filtering():
2672
unchanged = [(f, p) for (f, p) in unchanged
2673
if not next(accelerator_tree.iter_search_rules([p]))]
2674
unchanged = dict(unchanged)
2675
new_desired_files = []
2677
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2678
accelerator_path = unchanged.get(file_id)
2679
if accelerator_path is None:
2680
new_desired_files.append((file_id,
2681
(trans_id, tree_path, text_sha1)))
2683
pb.update(gettext('Adding file contents'), count + offset, total)
2685
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2688
contents = accelerator_tree.get_file(file_id, accelerator_path)
2689
if wt.supports_content_filtering():
2690
filters = wt._content_filter_stack(tree_path)
2691
contents = filtered_output_bytes(contents, filters,
2692
ContentFilterContext(tree_path, tree))
2694
tt.create_file(contents, trans_id, sha1=text_sha1)
2698
except AttributeError:
2699
# after filtering, contents may no longer be file-like
2703
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2704
tree.iter_files_bytes(new_desired_files)):
2705
if wt.supports_content_filtering():
2706
filters = wt._content_filter_stack(tree_path)
2707
contents = filtered_output_bytes(contents, filters,
2708
ContentFilterContext(tree_path, tree))
2709
tt.create_file(contents, trans_id, sha1=text_sha1)
2710
pb.update(gettext('Adding file contents'), count + offset, total)
2713
def _reparent_children(tt, old_parent, new_parent):
2714
for child in tt.iter_tree_children(old_parent):
2715
tt.adjust_path(tt.final_name(child), new_parent, child)
2718
def _reparent_transform_children(tt, old_parent, new_parent):
2719
by_parent = tt.by_parent()
2720
for child in by_parent[old_parent]:
2721
tt.adjust_path(tt.final_name(child), new_parent, child)
2722
return by_parent[old_parent]
2725
def _content_match(tree, entry, file_id, kind, target_path):
2726
if entry.kind != kind:
2728
if entry.kind == "directory":
2730
if entry.kind == "file":
2731
f = file(target_path, 'rb')
2733
if tree.get_file_text(file_id) == f.read():
2737
elif entry.kind == "symlink":
2738
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2743
def resolve_checkout(tt, conflicts, divert):
2744
new_conflicts = set()
2745
for c_type, conflict in ((c[0], c) for c in conflicts):
2746
# Anything but a 'duplicate' would indicate programmer error
2747
if c_type != 'duplicate':
2748
raise AssertionError(c_type)
2749
# Now figure out which is new and which is old
2750
if tt.new_contents(conflict[1]):
2751
new_file = conflict[1]
2752
old_file = conflict[2]
2754
new_file = conflict[2]
2755
old_file = conflict[1]
2757
# We should only get here if the conflict wasn't completely
2759
final_parent = tt.final_parent(old_file)
2760
if new_file in divert:
2761
new_name = tt.final_name(old_file)+'.diverted'
2762
tt.adjust_path(new_name, final_parent, new_file)
2763
new_conflicts.add((c_type, 'Diverted to',
2764
new_file, old_file))
2766
new_name = tt.final_name(old_file)+'.moved'
2767
tt.adjust_path(new_name, final_parent, old_file)
2768
new_conflicts.add((c_type, 'Moved existing file to',
2769
old_file, new_file))
2770
return new_conflicts
2773
def new_by_entry(tt, entry, parent_id, tree):
2774
"""Create a new file according to its inventory entry"""
2778
contents = tree.get_file(entry.file_id).readlines()
2779
executable = tree.is_executable(entry.file_id)
2780
return tt.new_file(name, parent_id, contents, entry.file_id,
2782
elif kind in ('directory', 'tree-reference'):
2783
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2784
if kind == 'tree-reference':
2785
tt.set_tree_reference(entry.reference_revision, trans_id)
2787
elif kind == 'symlink':
2788
target = tree.get_symlink_target(entry.file_id)
2789
return tt.new_symlink(name, parent_id, target, entry.file_id)
2791
raise errors.BadFileKindError(name, kind)
2794
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2795
filter_tree_path=None):
2796
"""Create new file contents according to tree contents.
2798
:param filter_tree_path: the tree path to use to lookup
2799
content filters to apply to the bytes output in the working tree.
2800
This only applies if the working tree supports content filtering.
2802
kind = tree.kind(file_id)
2803
if kind == 'directory':
2804
tt.create_directory(trans_id)
2805
elif kind == "file":
2807
tree_file = tree.get_file(file_id)
2809
bytes = tree_file.readlines()
2813
if wt.supports_content_filtering() and filter_tree_path is not None:
2814
filters = wt._content_filter_stack(filter_tree_path)
2815
bytes = filtered_output_bytes(bytes, filters,
2816
ContentFilterContext(filter_tree_path, tree))
2817
tt.create_file(bytes, trans_id)
2818
elif kind == "symlink":
2819
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2821
raise AssertionError('Unknown kind %r' % kind)
2824
def create_entry_executability(tt, entry, trans_id):
2825
"""Set the executability of a trans_id according to an inventory entry"""
2826
if entry.kind == "file":
2827
tt.set_executability(entry.executable, trans_id)
2830
def revert(working_tree, target_tree, filenames, backups=False,
2831
pb=None, change_reporter=None):
2832
"""Revert a working tree's contents to those of a target tree."""
2833
target_tree.lock_read()
2834
pb = ui.ui_factory.nested_progress_bar()
2835
tt = TreeTransform(working_tree, pb)
2837
pp = ProgressPhase("Revert phase", 3, pb)
2838
conflicts, merge_modified = _prepare_revert_transform(
2839
working_tree, target_tree, tt, filenames, backups, pp)
2841
change_reporter = delta._ChangeReporter(
2842
unversioned_filter=working_tree.is_ignored)
2843
delta.report_changes(tt.iter_changes(), change_reporter)
2844
for conflict in conflicts:
2845
trace.warning(unicode(conflict))
2848
working_tree.set_merge_modified(merge_modified)
2850
target_tree.unlock()
2856
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2857
backups, pp, basis_tree=None,
2858
merge_modified=None):
2859
child_pb = ui.ui_factory.nested_progress_bar()
2861
if merge_modified is None:
2862
merge_modified = working_tree.merge_modified()
2863
merge_modified = _alter_files(working_tree, target_tree, tt,
2864
child_pb, filenames, backups,
2865
merge_modified, basis_tree)
2868
child_pb = ui.ui_factory.nested_progress_bar()
2870
raw_conflicts = resolve_conflicts(tt, child_pb,
2871
lambda t, c: conflict_pass(t, c, target_tree))
2874
conflicts = cook_conflicts(raw_conflicts, tt)
2875
return conflicts, merge_modified
2878
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2879
backups, merge_modified, basis_tree=None):
2880
if basis_tree is not None:
2881
basis_tree.lock_read()
2882
# We ask the working_tree for its changes relative to the target, rather
2883
# than the target changes relative to the working tree. Because WT4 has an
2884
# optimizer to compare itself to a target, but no optimizer for the
2886
change_list = working_tree.iter_changes(target_tree,
2887
specific_files=specific_files, pb=pb)
2888
if target_tree.get_root_id() is None:
2894
for id_num, (file_id, path, changed_content, versioned, parent, name,
2895
kind, executable) in enumerate(change_list):
2896
target_path, wt_path = path
2897
target_versioned, wt_versioned = versioned
2898
target_parent, wt_parent = parent
2899
target_name, wt_name = name
2900
target_kind, wt_kind = kind
2901
target_executable, wt_executable = executable
2902
if skip_root and wt_parent is None:
2904
trans_id = tt.trans_id_file_id(file_id)
2907
keep_content = False
2908
if wt_kind == 'file' and (backups or target_kind is None):
2909
wt_sha1 = working_tree.get_file_sha1(file_id)
2910
if merge_modified.get(file_id) != wt_sha1:
2911
# acquire the basis tree lazily to prevent the
2912
# expense of accessing it when it's not needed ?
2913
# (Guessing, RBC, 200702)
2914
if basis_tree is None:
2915
basis_tree = working_tree.basis_tree()
2916
basis_tree.lock_read()
2917
if basis_tree.has_id(file_id):
2918
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2920
elif target_kind is None and not target_versioned:
2922
if wt_kind is not None:
2923
if not keep_content:
2924
tt.delete_contents(trans_id)
2925
elif target_kind is not None:
2926
parent_trans_id = tt.trans_id_file_id(wt_parent)
2927
backup_name = tt._available_backup_name(
2928
wt_name, parent_trans_id)
2929
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2930
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2931
if wt_versioned and target_versioned:
2932
tt.unversion_file(trans_id)
2933
tt.version_file(file_id, new_trans_id)
2934
# New contents should have the same unix perms as old
2937
trans_id = new_trans_id
2938
if target_kind in ('directory', 'tree-reference'):
2939
tt.create_directory(trans_id)
2940
if target_kind == 'tree-reference':
2941
revision = target_tree.get_reference_revision(file_id,
2943
tt.set_tree_reference(revision, trans_id)
2944
elif target_kind == 'symlink':
2945
tt.create_symlink(target_tree.get_symlink_target(file_id),
2947
elif target_kind == 'file':
2948
deferred_files.append((file_id, (trans_id, mode_id)))
2949
if basis_tree is None:
2950
basis_tree = working_tree.basis_tree()
2951
basis_tree.lock_read()
2952
new_sha1 = target_tree.get_file_sha1(file_id)
2953
if (basis_tree.has_id(file_id) and
2954
new_sha1 == basis_tree.get_file_sha1(file_id)):
2955
if file_id in merge_modified:
2956
del merge_modified[file_id]
2958
merge_modified[file_id] = new_sha1
2960
# preserve the execute bit when backing up
2961
if keep_content and wt_executable == target_executable:
2962
tt.set_executability(target_executable, trans_id)
2963
elif target_kind is not None:
2964
raise AssertionError(target_kind)
2965
if not wt_versioned and target_versioned:
2966
tt.version_file(file_id, trans_id)
2967
if wt_versioned and not target_versioned:
2968
tt.unversion_file(trans_id)
2969
if (target_name is not None and
2970
(wt_name != target_name or wt_parent != target_parent)):
2971
if target_name == '' and target_parent is None:
2972
parent_trans = ROOT_PARENT
2974
parent_trans = tt.trans_id_file_id(target_parent)
2975
if wt_parent is None and wt_versioned:
2976
tt.adjust_root_path(target_name, parent_trans)
2978
tt.adjust_path(target_name, parent_trans, trans_id)
2979
if wt_executable != target_executable and target_kind == "file":
2980
tt.set_executability(target_executable, trans_id)
2981
if working_tree.supports_content_filtering():
2982
for index, ((trans_id, mode_id), bytes) in enumerate(
2983
target_tree.iter_files_bytes(deferred_files)):
2984
file_id = deferred_files[index][0]
2985
# We're reverting a tree to the target tree so using the
2986
# target tree to find the file path seems the best choice
2987
# here IMO - Ian C 27/Oct/2009
2988
filter_tree_path = target_tree.id2path(file_id)
2989
filters = working_tree._content_filter_stack(filter_tree_path)
2990
bytes = filtered_output_bytes(bytes, filters,
2991
ContentFilterContext(filter_tree_path, working_tree))
2992
tt.create_file(bytes, trans_id, mode_id)
2994
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2996
tt.create_file(bytes, trans_id, mode_id)
2997
tt.fixup_new_roots()
2999
if basis_tree is not None:
3001
return merge_modified
3004
def resolve_conflicts(tt, pb=None, pass_func=None):
3005
"""Make many conflict-resolution attempts, but die if they fail"""
3006
if pass_func is None:
3007
pass_func = conflict_pass
3008
new_conflicts = set()
3009
pb = ui.ui_factory.nested_progress_bar()
3012
pb.update(gettext('Resolution pass'), n+1, 10)
3013
conflicts = tt.find_conflicts()
3014
if len(conflicts) == 0:
3015
return new_conflicts
3016
new_conflicts.update(pass_func(tt, conflicts))
3017
raise MalformedTransform(conflicts=conflicts)
3022
def conflict_pass(tt, conflicts, path_tree=None):
3023
"""Resolve some classes of conflicts.
3025
:param tt: The transform to resolve conflicts in
3026
:param conflicts: The conflicts to resolve
3027
:param path_tree: A Tree to get supplemental paths from
3029
new_conflicts = set()
3030
for c_type, conflict in ((c[0], c) for c in conflicts):
3031
if c_type == 'duplicate id':
3032
tt.unversion_file(conflict[1])
3033
new_conflicts.add((c_type, 'Unversioned existing file',
3034
conflict[1], conflict[2], ))
3035
elif c_type == 'duplicate':
3036
# files that were renamed take precedence
3037
final_parent = tt.final_parent(conflict[1])
3038
if tt.path_changed(conflict[1]):
3039
existing_file, new_file = conflict[2], conflict[1]
3041
existing_file, new_file = conflict[1], conflict[2]
3042
new_name = tt.final_name(existing_file) + '.moved'
3043
tt.adjust_path(new_name, final_parent, existing_file)
3044
new_conflicts.add((c_type, 'Moved existing file to',
3045
existing_file, new_file))
3046
elif c_type == 'parent loop':
3047
# break the loop by undoing one of the ops that caused the loop
3049
while not tt.path_changed(cur):
3050
cur = tt.final_parent(cur)
3051
new_conflicts.add((c_type, 'Cancelled move', cur,
3052
tt.final_parent(cur),))
3053
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3055
elif c_type == 'missing parent':
3056
trans_id = conflict[1]
3057
if trans_id in tt._removed_contents:
3058
cancel_deletion = True
3059
orphans = tt._get_potential_orphans(trans_id)
3061
cancel_deletion = False
3062
# All children are orphans
3065
tt.new_orphan(o, trans_id)
3066
except OrphaningError:
3067
# Something bad happened so we cancel the directory
3068
# deletion which will leave it in place with a
3069
# conflict. The user can deal with it from there.
3070
# Note that this also catch the case where we don't
3071
# want to create orphans and leave the directory in
3073
cancel_deletion = True
3076
# Cancel the directory deletion
3077
tt.cancel_deletion(trans_id)
3078
new_conflicts.add(('deleting parent', 'Not deleting',
3083
tt.final_name(trans_id)
3085
if path_tree is not None:
3086
file_id = tt.final_file_id(trans_id)
3088
file_id = tt.inactive_file_id(trans_id)
3089
_, entry = next(path_tree.iter_entries_by_dir(
3091
# special-case the other tree root (move its
3092
# children to current root)
3093
if entry.parent_id is None:
3095
moved = _reparent_transform_children(
3096
tt, trans_id, tt.root)
3098
new_conflicts.add((c_type, 'Moved to root',
3101
parent_trans_id = tt.trans_id_file_id(
3103
tt.adjust_path(entry.name, parent_trans_id,
3106
tt.create_directory(trans_id)
3107
new_conflicts.add((c_type, 'Created directory', trans_id))
3108
elif c_type == 'unversioned parent':
3109
file_id = tt.inactive_file_id(conflict[1])
3110
# special-case the other tree root (move its children instead)
3111
if path_tree and path_tree.has_id(file_id):
3112
if path_tree.path2id('') == file_id:
3113
# This is the root entry, skip it
3115
tt.version_file(file_id, conflict[1])
3116
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3117
elif c_type == 'non-directory parent':
3118
parent_id = conflict[1]
3119
parent_parent = tt.final_parent(parent_id)
3120
parent_name = tt.final_name(parent_id)
3121
parent_file_id = tt.final_file_id(parent_id)
3122
new_parent_id = tt.new_directory(parent_name + '.new',
3123
parent_parent, parent_file_id)
3124
_reparent_transform_children(tt, parent_id, new_parent_id)
3125
if parent_file_id is not None:
3126
tt.unversion_file(parent_id)
3127
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3128
elif c_type == 'versioning no contents':
3129
tt.cancel_versioning(conflict[1])
3130
return new_conflicts
3133
def cook_conflicts(raw_conflicts, tt):
3134
"""Generate a list of cooked conflicts, sorted by file path"""
3135
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3136
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3139
def iter_cook_conflicts(raw_conflicts, tt):
3141
for conflict in raw_conflicts:
3142
c_type = conflict[0]
3143
action = conflict[1]
3144
modified_path = fp.get_path(conflict[2])
3145
modified_id = tt.final_file_id(conflict[2])
3146
if len(conflict) == 3:
3147
yield conflicts.Conflict.factory(
3148
c_type, action=action, path=modified_path, file_id=modified_id)
3151
conflicting_path = fp.get_path(conflict[3])
3152
conflicting_id = tt.final_file_id(conflict[3])
3153
yield conflicts.Conflict.factory(
3154
c_type, action=action, path=modified_path,
3155
file_id=modified_id,
3156
conflict_path=conflicting_path,
3157
conflict_file_id=conflicting_id)
3160
class _FileMover(object):
3161
"""Moves and deletes files for TreeTransform, tracking operations"""
3164
self.past_renames = []
3165
self.pending_deletions = []
3167
def rename(self, from_, to):
3168
"""Rename a file from one path to another."""
3170
os.rename(from_, to)
3171
except OSError as e:
3172
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3173
raise errors.FileExists(to, str(e))
3174
# normal OSError doesn't include filenames so it's hard to see where
3175
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3176
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3177
self.past_renames.append((from_, to))
3179
def pre_delete(self, from_, to):
3180
"""Rename a file out of the way and mark it for deletion.
3182
Unlike os.unlink, this works equally well for files and directories.
3183
:param from_: The current file path
3184
:param to: A temporary path for the file
3186
self.rename(from_, to)
3187
self.pending_deletions.append(to)
3190
"""Reverse all renames that have been performed"""
3191
for from_, to in reversed(self.past_renames):
3193
os.rename(to, from_)
3194
except OSError as e:
3195
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3196
# after rollback, don't reuse _FileMover
3198
pending_deletions = None
3200
def apply_deletions(self):
3201
"""Apply all marked deletions"""
3202
for path in self.pending_deletions:
3204
# after apply_deletions, don't reuse _FileMover
3206
pending_deletions = None
added
removed
breezy/transform.py
