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
31
lazy_import.lazy_import(globals(), """
42
revision as _mod_revision,
46
from bzrlib.i18n import gettext
48
from bzrlib.errors import (DuplicateKey, MalformedTransform,
49
ReusingTransform, CantMoveRoot,
50
ExistingLimbo, ImmortalLimbo, NoFinalPath,
52
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
53
from bzrlib.osutils import (
62
from bzrlib.progress import ProgressPhase
63
from bzrlib.symbol_versioning import (
70
ROOT_PARENT = "root-parent"
72
def unique_add(map, key, value):
74
raise DuplicateKey(key=key)
79
class _TransformResults(object):
80
def __init__(self, modified_paths, rename_count):
82
self.modified_paths = modified_paths
83
self.rename_count = rename_count
86
class TreeTransformBase(object):
87
"""The base class for TreeTransform and its kin."""
89
def __init__(self, tree, pb=None,
93
:param tree: The tree that will be transformed, but not necessarily
96
:param case_sensitive: If True, the target of the transform is
97
case sensitive, not just case preserving.
102
# mapping of trans_id -> new basename
104
# mapping of trans_id -> new parent trans_id
105
self._new_parent = {}
106
# mapping of trans_id with new contents -> new file_kind
107
self._new_contents = {}
108
# mapping of trans_id => (sha1 of content, stat_value)
109
self._observed_sha1s = {}
110
# Set of trans_ids whose contents will be removed
111
self._removed_contents = set()
112
# Mapping of trans_id -> new execute-bit value
113
self._new_executability = {}
114
# Mapping of trans_id -> new tree-reference value
115
self._new_reference_revision = {}
116
# Mapping of trans_id -> new file_id
118
# Mapping of old file-id -> trans_id
119
self._non_present_ids = {}
120
# Mapping of new file_id -> trans_id
122
# Set of trans_ids that will be removed
123
self._removed_id = set()
124
# Mapping of path in old tree -> trans_id
125
self._tree_path_ids = {}
126
# Mapping trans_id -> path in old tree
127
self._tree_id_paths = {}
128
# The trans_id that will be used as the tree root
129
root_id = tree.get_root_id()
130
if root_id is not None:
131
self._new_root = self.trans_id_tree_file_id(root_id)
133
self._new_root = None
134
# Indicator of whether the transform has been applied
138
# Whether the target is case sensitive
139
self._case_sensitive_target = case_sensitive
140
# A counter of how many files have been renamed
141
self.rename_count = 0
144
"""Support Context Manager API."""
147
def __exit__(self, exc_type, exc_val, exc_tb):
148
"""Support Context Manager API."""
152
"""Release the working tree lock, if held.
154
This is required if apply has not been invoked, but can be invoked
157
if self._tree is None:
162
def __get_root(self):
163
return self._new_root
165
root = property(__get_root)
167
def _assign_id(self):
168
"""Produce a new tranform id"""
169
new_id = "new-%s" % self._id_number
173
def create_path(self, name, parent):
174
"""Assign a transaction id to a new path"""
175
trans_id = self._assign_id()
176
unique_add(self._new_name, trans_id, name)
177
unique_add(self._new_parent, trans_id, parent)
180
def adjust_path(self, name, parent, trans_id):
181
"""Change the path that is assigned to a transaction id."""
183
raise ValueError("Parent trans-id may not be None")
184
if trans_id == self._new_root:
186
self._new_name[trans_id] = name
187
self._new_parent[trans_id] = parent
189
def adjust_root_path(self, name, parent):
190
"""Emulate moving the root by moving all children, instead.
192
We do this by undoing the association of root's transaction id with the
193
current tree. This allows us to create a new directory with that
194
transaction id. We unversion the root directory and version the
195
physically new directory, and hope someone versions the tree root
198
old_root = self._new_root
199
old_root_file_id = self.final_file_id(old_root)
200
# force moving all children of root
201
for child_id in self.iter_tree_children(old_root):
202
if child_id != parent:
203
self.adjust_path(self.final_name(child_id),
204
self.final_parent(child_id), child_id)
205
file_id = self.final_file_id(child_id)
206
if file_id is not None:
207
self.unversion_file(child_id)
208
self.version_file(file_id, child_id)
210
# the physical root needs a new transaction id
211
self._tree_path_ids.pop("")
212
self._tree_id_paths.pop(old_root)
213
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
214
if parent == old_root:
215
parent = self._new_root
216
self.adjust_path(name, parent, old_root)
217
self.create_directory(old_root)
218
self.version_file(old_root_file_id, old_root)
219
self.unversion_file(self._new_root)
221
def fixup_new_roots(self):
222
"""Reinterpret requests to change the root directory
224
Instead of creating a root directory, or moving an existing directory,
225
all the attributes and children of the new root are applied to the
226
existing root directory.
228
This means that the old root trans-id becomes obsolete, so it is
229
recommended only to invoke this after the root trans-id has become
233
new_roots = [k for k, v in self._new_parent.iteritems() if v is
235
if len(new_roots) < 1:
237
if len(new_roots) != 1:
238
raise ValueError('A tree cannot have two roots!')
239
if self._new_root is None:
240
self._new_root = new_roots[0]
242
old_new_root = new_roots[0]
243
# unversion the new root's directory.
244
if self.final_kind(self._new_root) is None:
245
file_id = self.final_file_id(old_new_root)
247
file_id = self.final_file_id(self._new_root)
248
if old_new_root in self._new_id:
249
self.cancel_versioning(old_new_root)
251
self.unversion_file(old_new_root)
252
# if, at this stage, root still has an old file_id, zap it so we can
253
# stick a new one in.
254
if (self.tree_file_id(self._new_root) is not None and
255
self._new_root not in self._removed_id):
256
self.unversion_file(self._new_root)
257
if file_id is not None:
258
self.version_file(file_id, self._new_root)
260
# Now move children of new root into old root directory.
261
# Ensure all children are registered with the transaction, but don't
262
# use directly-- some tree children have new parents
263
list(self.iter_tree_children(old_new_root))
264
# Move all children of new root into old root directory.
265
for child in self.by_parent().get(old_new_root, []):
266
self.adjust_path(self.final_name(child), self._new_root, child)
268
# Ensure old_new_root has no directory.
269
if old_new_root in self._new_contents:
270
self.cancel_creation(old_new_root)
272
self.delete_contents(old_new_root)
274
# prevent deletion of root directory.
275
if self._new_root in self._removed_contents:
276
self.cancel_deletion(self._new_root)
278
# destroy path info for old_new_root.
279
del self._new_parent[old_new_root]
280
del self._new_name[old_new_root]
282
def trans_id_tree_file_id(self, inventory_id):
283
"""Determine the transaction id of a working tree file.
285
This reflects only files that already exist, not ones that will be
286
added by transactions.
288
if inventory_id is None:
289
raise ValueError('None is not a valid file id')
290
path = self._tree.id2path(inventory_id)
291
return self.trans_id_tree_path(path)
293
def trans_id_file_id(self, file_id):
294
"""Determine or set the transaction id associated with a file ID.
295
A new id is only created for file_ids that were never present. If
296
a transaction has been unversioned, it is deliberately still returned.
297
(this will likely lead to an unversioned parent conflict.)
300
raise ValueError('None is not a valid file id')
301
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
302
return self._r_new_id[file_id]
305
self._tree.iter_entries_by_dir([file_id]).next()
306
except StopIteration:
307
if file_id in self._non_present_ids:
308
return self._non_present_ids[file_id]
310
trans_id = self._assign_id()
311
self._non_present_ids[file_id] = trans_id
314
return self.trans_id_tree_file_id(file_id)
316
def trans_id_tree_path(self, path):
317
"""Determine (and maybe set) the transaction ID for a tree path."""
318
path = self.canonical_path(path)
319
if path not in self._tree_path_ids:
320
self._tree_path_ids[path] = self._assign_id()
321
self._tree_id_paths[self._tree_path_ids[path]] = path
322
return self._tree_path_ids[path]
324
def get_tree_parent(self, trans_id):
325
"""Determine id of the parent in the tree."""
326
path = self._tree_id_paths[trans_id]
329
return self.trans_id_tree_path(os.path.dirname(path))
331
def delete_contents(self, trans_id):
332
"""Schedule the contents of a path entry for deletion"""
333
kind = self.tree_kind(trans_id)
335
self._removed_contents.add(trans_id)
337
def cancel_deletion(self, trans_id):
338
"""Cancel a scheduled deletion"""
339
self._removed_contents.remove(trans_id)
341
def unversion_file(self, trans_id):
342
"""Schedule a path entry to become unversioned"""
343
self._removed_id.add(trans_id)
345
def delete_versioned(self, trans_id):
346
"""Delete and unversion a versioned file"""
347
self.delete_contents(trans_id)
348
self.unversion_file(trans_id)
350
def set_executability(self, executability, trans_id):
351
"""Schedule setting of the 'execute' bit
352
To unschedule, set to None
354
if executability is None:
355
del self._new_executability[trans_id]
357
unique_add(self._new_executability, trans_id, executability)
359
def set_tree_reference(self, revision_id, trans_id):
360
"""Set the reference associated with a directory"""
361
unique_add(self._new_reference_revision, trans_id, revision_id)
363
def version_file(self, file_id, trans_id):
364
"""Schedule a file to become versioned."""
367
unique_add(self._new_id, trans_id, file_id)
368
unique_add(self._r_new_id, file_id, trans_id)
370
def cancel_versioning(self, trans_id):
371
"""Undo a previous versioning of a file"""
372
file_id = self._new_id[trans_id]
373
del self._new_id[trans_id]
374
del self._r_new_id[file_id]
376
def new_paths(self, filesystem_only=False):
377
"""Determine the paths of all new and changed files.
379
:param filesystem_only: if True, only calculate values for files
380
that require renames or execute bit changes.
384
stale_ids = self._needs_rename.difference(self._new_name)
385
stale_ids.difference_update(self._new_parent)
386
stale_ids.difference_update(self._new_contents)
387
stale_ids.difference_update(self._new_id)
388
needs_rename = self._needs_rename.difference(stale_ids)
389
id_sets = (needs_rename, self._new_executability)
391
id_sets = (self._new_name, self._new_parent, self._new_contents,
392
self._new_id, self._new_executability)
393
for id_set in id_sets:
394
new_ids.update(id_set)
395
return sorted(FinalPaths(self).get_paths(new_ids))
397
def _inventory_altered(self):
398
"""Determine which trans_ids need new Inventory entries.
400
An new entry is needed when anything that would be reflected by an
401
inventory entry changes, including file name, file_id, parent file_id,
402
file kind, and the execute bit.
404
Some care is taken to return entries with real changes, not cases
405
where the value is deleted and then restored to its original value,
406
but some actually unchanged values may be returned.
408
:returns: A list of (path, trans_id) for all items requiring an
409
inventory change. Ordered by path.
412
# Find entries whose file_ids are new (or changed).
413
new_file_id = set(t for t in self._new_id
414
if self._new_id[t] != self.tree_file_id(t))
415
for id_set in [self._new_name, self._new_parent, new_file_id,
416
self._new_executability]:
417
changed_ids.update(id_set)
418
# removing implies a kind change
419
changed_kind = set(self._removed_contents)
421
changed_kind.intersection_update(self._new_contents)
422
# Ignore entries that are already known to have changed.
423
changed_kind.difference_update(changed_ids)
424
# to keep only the truly changed ones
425
changed_kind = (t for t in changed_kind
426
if self.tree_kind(t) != self.final_kind(t))
427
# all kind changes will alter the inventory
428
changed_ids.update(changed_kind)
429
# To find entries with changed parent_ids, find parents which existed,
430
# but changed file_id.
431
changed_file_id = set(t for t in new_file_id if t in self._removed_id)
432
# Now add all their children to the set.
433
for parent_trans_id in new_file_id:
434
changed_ids.update(self.iter_tree_children(parent_trans_id))
435
return sorted(FinalPaths(self).get_paths(changed_ids))
437
def final_kind(self, trans_id):
438
"""Determine the final file kind, after any changes applied.
440
:return: None if the file does not exist/has no contents. (It is
441
conceivable that a path would be created without the corresponding
442
contents insertion command)
444
if trans_id in self._new_contents:
445
return self._new_contents[trans_id]
446
elif trans_id in self._removed_contents:
449
return self.tree_kind(trans_id)
451
def tree_file_id(self, trans_id):
452
"""Determine the file id associated with the trans_id in the tree"""
454
path = self._tree_id_paths[trans_id]
456
# the file is a new, unversioned file, or invalid trans_id
458
# the file is old; the old id is still valid
459
if self._new_root == trans_id:
460
return self._tree.get_root_id()
461
return self._tree.path2id(path)
463
def final_file_id(self, trans_id):
464
"""Determine the file id after any changes are applied, or None.
466
None indicates that the file will not be versioned after changes are
470
return self._new_id[trans_id]
472
if trans_id in self._removed_id:
474
return self.tree_file_id(trans_id)
476
def inactive_file_id(self, trans_id):
477
"""Return the inactive file_id associated with a transaction id.
478
That is, the one in the tree or in non_present_ids.
479
The file_id may actually be active, too.
481
file_id = self.tree_file_id(trans_id)
482
if file_id is not None:
484
for key, value in self._non_present_ids.iteritems():
485
if value == trans_id:
488
def final_parent(self, trans_id):
489
"""Determine the parent file_id, after any changes are applied.
491
ROOT_PARENT is returned for the tree root.
494
return self._new_parent[trans_id]
496
return self.get_tree_parent(trans_id)
498
def final_name(self, trans_id):
499
"""Determine the final filename, after all changes are applied."""
501
return self._new_name[trans_id]
504
return os.path.basename(self._tree_id_paths[trans_id])
506
raise NoFinalPath(trans_id, self)
509
"""Return a map of parent: children for known parents.
511
Only new paths and parents of tree files with assigned ids are used.
514
items = list(self._new_parent.iteritems())
515
items.extend((t, self.final_parent(t)) for t in
516
self._tree_id_paths.keys())
517
for trans_id, parent_id in items:
518
if parent_id not in by_parent:
519
by_parent[parent_id] = set()
520
by_parent[parent_id].add(trans_id)
523
def path_changed(self, trans_id):
524
"""Return True if a trans_id's path has changed."""
525
return (trans_id in self._new_name) or (trans_id in self._new_parent)
527
def new_contents(self, trans_id):
528
return (trans_id in self._new_contents)
530
def find_conflicts(self):
531
"""Find any violations of inventory or filesystem invariants"""
532
if self._done is True:
533
raise ReusingTransform()
535
# ensure all children of all existent parents are known
536
# all children of non-existent parents are known, by definition.
537
self._add_tree_children()
538
by_parent = self.by_parent()
539
conflicts.extend(self._unversioned_parents(by_parent))
540
conflicts.extend(self._parent_loops())
541
conflicts.extend(self._duplicate_entries(by_parent))
542
conflicts.extend(self._duplicate_ids())
543
conflicts.extend(self._parent_type_conflicts(by_parent))
544
conflicts.extend(self._improper_versioning())
545
conflicts.extend(self._executability_conflicts())
546
conflicts.extend(self._overwrite_conflicts())
549
def _check_malformed(self):
550
conflicts = self.find_conflicts()
551
if len(conflicts) != 0:
552
raise MalformedTransform(conflicts=conflicts)
554
def _add_tree_children(self):
555
"""Add all the children of all active parents to the known paths.
557
Active parents are those which gain children, and those which are
558
removed. This is a necessary first step in detecting conflicts.
560
parents = self.by_parent().keys()
561
parents.extend([t for t in self._removed_contents if
562
self.tree_kind(t) == 'directory'])
563
for trans_id in self._removed_id:
564
file_id = self.tree_file_id(trans_id)
565
if file_id is not None:
566
if self._tree.stored_kind(file_id) == 'directory':
567
parents.append(trans_id)
568
elif self.tree_kind(trans_id) == 'directory':
569
parents.append(trans_id)
571
for parent_id in parents:
572
# ensure that all children are registered with the transaction
573
list(self.iter_tree_children(parent_id))
575
@deprecated_method(deprecated_in((2, 3, 0)))
576
def has_named_child(self, by_parent, parent_id, name):
577
return self._has_named_child(
578
name, parent_id, known_children=by_parent.get(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 is not 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 by_parent.iteritems():
645
if parent_id is 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.iterkeys():
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 by_parent.itervalues():
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 self._new_id.iteritems():
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 by_parent.iteritems():
744
if parent_id is 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 | (0100 & ~umask)
774
# Enable x-bit for others only if they can read it.
775
if current_mode & 0004:
776
to_mode |= 0001 & ~umask
777
if current_mode & 0040:
778
to_mode |= 0010 & ~umask
780
to_mode = current_mode & ~0111
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.keys())
879
trans_ids.update(self._removed_contents)
880
trans_ids.update(self._new_contents.keys())
881
trans_ids.update(self._new_executability.keys())
882
trans_ids.update(self._new_name.keys())
883
trans_ids.update(self._new_parent.keys())
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.keys() + to_trans_ids.keys()):
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
self._new_name.items())
1107
new_executability = dict((k, int(v)) for k, v in
1108
self._new_executability.items())
1109
tree_path_ids = dict((k.encode('utf-8'), v)
1110
for k, v in self._tree_path_ids.items())
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 self._new_contents.items():
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 = records.next()
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 attribs['_new_name'].items())
1148
self._new_parent = attribs['_new_parent']
1149
self._new_executability = dict((k, bool(v)) for k, v in
1150
attribs['_new_executability'].items())
1151
self._new_id = attribs['_new_id']
1152
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1153
self._tree_path_ids = {}
1154
self._tree_id_paths = {}
1155
for bytepath, trans_id in attribs['_tree_path_ids'].items():
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 = self._limbo_files.values() + list(
1212
self._possibly_stale_limbo_files)
1213
limbo_paths = sorted(limbo_paths, reverse=True)
1214
for path in limbo_paths:
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)
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
# FIXME: There is no tree config, so we use the branch one (it's weird
1407
# to define it this way as orphaning can only occur in a working tree,
1408
# but that's all we have (for now). It will find the option in
1409
# locations.conf or bazaar.conf though) -- vila 20100916
1410
conf = self._tree.branch.get_config()
1411
conf_var_name = 'bzr.transform.orphan_policy'
1412
orphan_policy = conf.get_user_option(conf_var_name)
1413
default_policy = orphaning_registry.default_key
1414
if orphan_policy is None:
1415
orphan_policy = default_policy
1416
if orphan_policy not in orphaning_registry:
1417
trace.warning('%s (from %s) is not a known policy, defaulting '
1418
'to %s' % (orphan_policy, conf_var_name, default_policy))
1419
orphan_policy = default_policy
1420
handle_orphan = orphaning_registry.get(orphan_policy)
1421
handle_orphan(self, trans_id, parent_id)
1424
class OrphaningError(errors.BzrError):
1426
# Only bugs could lead to such exception being seen by the user
1427
internal_error = True
1428
_fmt = "Error while orphaning %s in %s directory"
1430
def __init__(self, orphan, parent):
1431
errors.BzrError.__init__(self)
1432
self.orphan = orphan
1433
self.parent = parent
1436
class OrphaningForbidden(OrphaningError):
1438
_fmt = "Policy: %s doesn't allow creating orphans."
1440
def __init__(self, policy):
1441
errors.BzrError.__init__(self)
1442
self.policy = policy
1445
def move_orphan(tt, orphan_id, parent_id):
1446
"""See TreeTransformBase.new_orphan.
1448
This creates a new orphan in the `bzr-orphans` dir at the root of the
1451
:param tt: The TreeTransform orphaning `trans_id`.
1453
:param orphan_id: The trans id that should be orphaned.
1455
:param parent_id: The orphan parent trans id.
1457
# Add the orphan dir if it doesn't exist
1458
orphan_dir_basename = 'bzr-orphans'
1459
od_id = tt.trans_id_tree_path(orphan_dir_basename)
1460
if tt.final_kind(od_id) is None:
1461
tt.create_directory(od_id)
1462
parent_path = tt._tree_id_paths[parent_id]
1463
# Find a name that doesn't exist yet in the orphan dir
1464
actual_name = tt.final_name(orphan_id)
1465
new_name = tt._available_backup_name(actual_name, od_id)
1466
tt.adjust_path(new_name, od_id, orphan_id)
1467
trace.warning('%s has been orphaned in %s'
1468
% (joinpath(parent_path, actual_name), orphan_dir_basename))
1471
def refuse_orphan(tt, orphan_id, parent_id):
1472
"""See TreeTransformBase.new_orphan.
1474
This refuses to create orphan, letting the caller handle the conflict.
1476
raise OrphaningForbidden('never')
1479
orphaning_registry = registry.Registry()
1480
orphaning_registry.register(
1481
'conflict', refuse_orphan,
1482
'Leave orphans in place and create a conflict on the directory.')
1483
orphaning_registry.register(
1484
'move', move_orphan,
1485
'Move orphans into the bzr-orphans directory.')
1486
orphaning_registry._set_default_key('conflict')
1489
class TreeTransform(DiskTreeTransform):
1490
"""Represent a tree transformation.
1492
This object is designed to support incremental generation of the transform,
1495
However, it gives optimum performance when parent directories are created
1496
before their contents. The transform is then able to put child files
1497
directly in their parent directory, avoiding later renames.
1499
It is easy to produce malformed transforms, but they are generally
1500
harmless. Attempting to apply a malformed transform will cause an
1501
exception to be raised before any modifications are made to the tree.
1503
Many kinds of malformed transforms can be corrected with the
1504
resolve_conflicts function. The remaining ones indicate programming error,
1505
such as trying to create a file with no path.
1507
Two sets of file creation methods are supplied. Convenience methods are:
1512
These are composed of the low-level methods:
1514
* create_file or create_directory or create_symlink
1518
Transform/Transaction ids
1519
-------------------------
1520
trans_ids are temporary ids assigned to all files involved in a transform.
1521
It's possible, even common, that not all files in the Tree have trans_ids.
1523
trans_ids are used because filenames and file_ids are not good enough
1524
identifiers; filenames change, and not all files have file_ids. File-ids
1525
are also associated with trans-ids, so that moving a file moves its
1528
trans_ids are only valid for the TreeTransform that generated them.
1532
Limbo is a temporary directory use to hold new versions of files.
1533
Files are added to limbo by create_file, create_directory, create_symlink,
1534
and their convenience variants (new_*). Files may be removed from limbo
1535
using cancel_creation. Files are renamed from limbo into their final
1536
location as part of TreeTransform.apply
1538
Limbo must be cleaned up, by either calling TreeTransform.apply or
1539
calling TreeTransform.finalize.
1541
Files are placed into limbo inside their parent directories, where
1542
possible. This reduces subsequent renames, and makes operations involving
1543
lots of files faster. This optimization is only possible if the parent
1544
directory is created *before* creating any of its children, so avoid
1545
creating children before parents, where possible.
1549
This temporary directory is used by _FileMover for storing files that are
1550
about to be deleted. In case of rollback, the files will be restored.
1551
FileMover does not delete files until it is sure that a rollback will not
1554
def __init__(self, tree, pb=None):
1555
"""Note: a tree_write lock is taken on the tree.
1557
Use TreeTransform.finalize() to release the lock (can be omitted if
1558
TreeTransform.apply() called).
1560
tree.lock_tree_write()
1563
limbodir = urlutils.local_path_from_url(
1564
tree._transport.abspath('limbo'))
1565
osutils.ensure_empty_directory_exists(
1567
errors.ExistingLimbo)
1568
deletiondir = urlutils.local_path_from_url(
1569
tree._transport.abspath('pending-deletion'))
1570
osutils.ensure_empty_directory_exists(
1572
errors.ExistingPendingDeletion)
1577
# Cache of realpath results, to speed up canonical_path
1578
self._realpaths = {}
1579
# Cache of relpath results, to speed up canonical_path
1581
DiskTreeTransform.__init__(self, tree, limbodir, pb,
1582
tree.case_sensitive)
1583
self._deletiondir = deletiondir
1585
def canonical_path(self, path):
1586
"""Get the canonical tree-relative path"""
1587
# don't follow final symlinks
1588
abs = self._tree.abspath(path)
1589
if abs in self._relpaths:
1590
return self._relpaths[abs]
1591
dirname, basename = os.path.split(abs)
1592
if dirname not in self._realpaths:
1593
self._realpaths[dirname] = os.path.realpath(dirname)
1594
dirname = self._realpaths[dirname]
1595
abs = pathjoin(dirname, basename)
1596
if dirname in self._relpaths:
1597
relpath = pathjoin(self._relpaths[dirname], basename)
1598
relpath = relpath.rstrip('/\\')
1600
relpath = self._tree.relpath(abs)
1601
self._relpaths[abs] = relpath
1604
def tree_kind(self, trans_id):
1605
"""Determine the file kind in the working tree.
1607
:returns: The file kind or None if the file does not exist
1609
path = self._tree_id_paths.get(trans_id)
1613
return file_kind(self._tree.abspath(path))
1614
except errors.NoSuchFile:
1617
def _set_mode(self, trans_id, mode_id, typefunc):
1618
"""Set the mode of new file contents.
1619
The mode_id is the existing file to get the mode from (often the same
1620
as trans_id). The operation is only performed if there's a mode match
1621
according to typefunc.
1626
old_path = self._tree_id_paths[mode_id]
1630
mode = os.stat(self._tree.abspath(old_path)).st_mode
1632
if e.errno in (errno.ENOENT, errno.ENOTDIR):
1633
# Either old_path doesn't exist, or the parent of the
1634
# target is not a directory (but will be one eventually)
1635
# Either way, we know it doesn't exist *right now*
1636
# See also bug #248448
1641
osutils.chmod_if_possible(self._limbo_name(trans_id), mode)
1643
def iter_tree_children(self, parent_id):
1644
"""Iterate through the entry's tree children, if any"""
1646
path = self._tree_id_paths[parent_id]
1650
children = os.listdir(self._tree.abspath(path))
1652
if not (osutils._is_error_enotdir(e)
1653
or e.errno in (errno.ENOENT, errno.ESRCH)):
1657
for child in children:
1658
childpath = joinpath(path, child)
1659
if self._tree.is_control_filename(childpath):
1661
yield self.trans_id_tree_path(childpath)
1663
def _generate_limbo_path(self, trans_id):
1664
"""Generate a limbo path using the final path if possible.
1666
This optimizes the performance of applying the tree transform by
1667
avoiding renames. These renames can be avoided only when the parent
1668
directory is already scheduled for creation.
1670
If the final path cannot be used, falls back to using the trans_id as
1673
parent = self._new_parent.get(trans_id)
1674
# if the parent directory is already in limbo (e.g. when building a
1675
# tree), choose a limbo name inside the parent, to reduce further
1677
use_direct_path = False
1678
if self._new_contents.get(parent) == 'directory':
1679
filename = self._new_name.get(trans_id)
1680
if filename is not None:
1681
if parent not in self._limbo_children:
1682
self._limbo_children[parent] = set()
1683
self._limbo_children_names[parent] = {}
1684
use_direct_path = True
1685
# the direct path can only be used if no other file has
1686
# already taken this pathname, i.e. if the name is unused, or
1687
# if it is already associated with this trans_id.
1688
elif self._case_sensitive_target:
1689
if (self._limbo_children_names[parent].get(filename)
1690
in (trans_id, None)):
1691
use_direct_path = True
1693
for l_filename, l_trans_id in\
1694
self._limbo_children_names[parent].iteritems():
1695
if l_trans_id == trans_id:
1697
if l_filename.lower() == filename.lower():
1700
use_direct_path = True
1702
if not use_direct_path:
1703
return DiskTreeTransform._generate_limbo_path(self, trans_id)
1705
limbo_name = pathjoin(self._limbo_files[parent], filename)
1706
self._limbo_children[parent].add(trans_id)
1707
self._limbo_children_names[parent][filename] = trans_id
1711
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1712
"""Apply all changes to the inventory and filesystem.
1714
If filesystem or inventory conflicts are present, MalformedTransform
1717
If apply succeeds, finalize is not necessary.
1719
:param no_conflicts: if True, the caller guarantees there are no
1720
conflicts, so no check is made.
1721
:param precomputed_delta: An inventory delta to use instead of
1723
:param _mover: Supply an alternate FileMover, for testing
1725
if not no_conflicts:
1726
self._check_malformed()
1727
child_pb = ui.ui_factory.nested_progress_bar()
1729
if precomputed_delta is None:
1730
child_pb.update(gettext('Apply phase'), 0, 2)
1731
inventory_delta = self._generate_inventory_delta()
1734
inventory_delta = precomputed_delta
1737
mover = _FileMover()
1741
child_pb.update(gettext('Apply phase'), 0 + offset, 2 + offset)
1742
self._apply_removals(mover)
1743
child_pb.update(gettext('Apply phase'), 1 + offset, 2 + offset)
1744
modified_paths = self._apply_insertions(mover)
1749
mover.apply_deletions()
1752
if self.final_file_id(self.root) is None:
1753
inventory_delta = [e for e in inventory_delta if e[0] != '']
1754
self._tree.apply_inventory_delta(inventory_delta)
1755
self._apply_observed_sha1s()
1758
return _TransformResults(modified_paths, self.rename_count)
1760
def _generate_inventory_delta(self):
1761
"""Generate an inventory delta for the current transform."""
1762
inventory_delta = []
1763
child_pb = ui.ui_factory.nested_progress_bar()
1764
new_paths = self._inventory_altered()
1765
total_entries = len(new_paths) + len(self._removed_id)
1767
for num, trans_id in enumerate(self._removed_id):
1769
child_pb.update(gettext('removing file'), num, total_entries)
1770
if trans_id == self._new_root:
1771
file_id = self._tree.get_root_id()
1773
file_id = self.tree_file_id(trans_id)
1774
# File-id isn't really being deleted, just moved
1775
if file_id in self._r_new_id:
1777
path = self._tree_id_paths[trans_id]
1778
inventory_delta.append((path, None, file_id, None))
1779
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1781
entries = self._tree.iter_entries_by_dir(
1782
new_path_file_ids.values())
1783
old_paths = dict((e.file_id, p) for p, e in entries)
1785
for num, (path, trans_id) in enumerate(new_paths):
1787
child_pb.update(gettext('adding file'),
1788
num + len(self._removed_id), total_entries)
1789
file_id = new_path_file_ids[trans_id]
1793
kind = self.final_kind(trans_id)
1795
kind = self._tree.stored_kind(file_id)
1796
parent_trans_id = self.final_parent(trans_id)
1797
parent_file_id = new_path_file_ids.get(parent_trans_id)
1798
if parent_file_id is None:
1799
parent_file_id = self.final_file_id(parent_trans_id)
1800
if trans_id in self._new_reference_revision:
1801
new_entry = inventory.TreeReference(
1803
self._new_name[trans_id],
1804
self.final_file_id(self._new_parent[trans_id]),
1805
None, self._new_reference_revision[trans_id])
1807
new_entry = inventory.make_entry(kind,
1808
self.final_name(trans_id),
1809
parent_file_id, file_id)
1810
old_path = old_paths.get(new_entry.file_id)
1811
new_executability = self._new_executability.get(trans_id)
1812
if new_executability is not None:
1813
new_entry.executable = new_executability
1814
inventory_delta.append(
1815
(old_path, path, new_entry.file_id, new_entry))
1818
return inventory_delta
1820
def _apply_removals(self, mover):
1821
"""Perform tree operations that remove directory/inventory names.
1823
That is, delete files that are to be deleted, and put any files that
1824
need renaming into limbo. This must be done in strict child-to-parent
1827
If inventory_delta is None, no inventory delta generation is performed.
1829
tree_paths = list(self._tree_path_ids.iteritems())
1830
tree_paths.sort(reverse=True)
1831
child_pb = ui.ui_factory.nested_progress_bar()
1833
for num, (path, trans_id) in enumerate(tree_paths):
1834
# do not attempt to move root into a subdirectory of itself.
1837
child_pb.update(gettext('removing file'), num, len(tree_paths))
1838
full_path = self._tree.abspath(path)
1839
if trans_id in self._removed_contents:
1840
delete_path = os.path.join(self._deletiondir, trans_id)
1841
mover.pre_delete(full_path, delete_path)
1842
elif (trans_id in self._new_name
1843
or trans_id in self._new_parent):
1845
mover.rename(full_path, self._limbo_name(trans_id))
1846
except errors.TransformRenameFailed, e:
1847
if e.errno != errno.ENOENT:
1850
self.rename_count += 1
1854
def _apply_insertions(self, mover):
1855
"""Perform tree operations that insert directory/inventory names.
1857
That is, create any files that need to be created, and restore from
1858
limbo any files that needed renaming. This must be done in strict
1859
parent-to-child order.
1861
If inventory_delta is None, no inventory delta is calculated, and
1862
no list of modified paths is returned.
1864
new_paths = self.new_paths(filesystem_only=True)
1866
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1868
child_pb = ui.ui_factory.nested_progress_bar()
1870
for num, (path, trans_id) in enumerate(new_paths):
1872
child_pb.update(gettext('adding file'), num, len(new_paths))
1873
full_path = self._tree.abspath(path)
1874
if trans_id in self._needs_rename:
1876
mover.rename(self._limbo_name(trans_id), full_path)
1877
except errors.TransformRenameFailed, e:
1878
# We may be renaming a dangling inventory id
1879
if e.errno != errno.ENOENT:
1882
self.rename_count += 1
1883
# TODO: if trans_id in self._observed_sha1s, we should
1884
# re-stat the final target, since ctime will be
1885
# updated by the change.
1886
if (trans_id in self._new_contents or
1887
self.path_changed(trans_id)):
1888
if trans_id in self._new_contents:
1889
modified_paths.append(full_path)
1890
if trans_id in self._new_executability:
1891
self._set_executability(path, trans_id)
1892
if trans_id in self._observed_sha1s:
1893
o_sha1, o_st_val = self._observed_sha1s[trans_id]
1894
st = osutils.lstat(full_path)
1895
self._observed_sha1s[trans_id] = (o_sha1, st)
1898
for path, trans_id in new_paths:
1899
# new_paths includes stuff like workingtree conflicts. Only the
1900
# stuff in new_contents actually comes from limbo.
1901
if trans_id in self._limbo_files:
1902
del self._limbo_files[trans_id]
1903
self._new_contents.clear()
1904
return modified_paths
1906
def _apply_observed_sha1s(self):
1907
"""After we have finished renaming everything, update observed sha1s
1909
This has to be done after self._tree.apply_inventory_delta, otherwise
1910
it doesn't know anything about the files we are updating. Also, we want
1911
to do this as late as possible, so that most entries end up cached.
1913
# TODO: this doesn't update the stat information for directories. So
1914
# the first 'bzr status' will still need to rewrite
1915
# .bzr/checkout/dirstate. However, we at least don't need to
1916
# re-read all of the files.
1917
# TODO: If the operation took a while, we could do a time.sleep(3) here
1918
# to allow the clock to tick over and ensure we won't have any
1919
# problems. (we could observe start time, and finish time, and if
1920
# it is less than eg 10% overhead, add a sleep call.)
1921
paths = FinalPaths(self)
1922
for trans_id, observed in self._observed_sha1s.iteritems():
1923
path = paths.get_path(trans_id)
1924
# We could get the file_id, but dirstate prefers to use the path
1925
# anyway, and it is 'cheaper' to determine.
1926
# file_id = self._new_id[trans_id]
1927
self._tree._observed_sha1(None, path, observed)
1930
class TransformPreview(DiskTreeTransform):
1931
"""A TreeTransform for generating preview trees.
1933
Unlike TreeTransform, this version works when the input tree is a
1934
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1935
unversioned files in the input tree.
1938
def __init__(self, tree, pb=None, case_sensitive=True):
1940
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1941
DiskTreeTransform.__init__(self, tree, limbodir, pb, case_sensitive)
1943
def canonical_path(self, path):
1946
def tree_kind(self, trans_id):
1947
path = self._tree_id_paths.get(trans_id)
1950
kind = self._tree.path_content_summary(path)[0]
1951
if kind == 'missing':
1955
def _set_mode(self, trans_id, mode_id, typefunc):
1956
"""Set the mode of new file contents.
1957
The mode_id is the existing file to get the mode from (often the same
1958
as trans_id). The operation is only performed if there's a mode match
1959
according to typefunc.
1961
# is it ok to ignore this? probably
1964
def iter_tree_children(self, parent_id):
1965
"""Iterate through the entry's tree children, if any"""
1967
path = self._tree_id_paths[parent_id]
1970
file_id = self.tree_file_id(parent_id)
1973
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1974
children = getattr(entry, 'children', {})
1975
for child in children:
1976
childpath = joinpath(path, child)
1977
yield self.trans_id_tree_path(childpath)
1979
def new_orphan(self, trans_id, parent_id):
1980
raise NotImplementedError(self.new_orphan)
1983
class _PreviewTree(tree.InventoryTree):
1984
"""Partial implementation of Tree to support show_diff_trees"""
1986
def __init__(self, transform):
1987
self._transform = transform
1988
self._final_paths = FinalPaths(transform)
1989
self.__by_parent = None
1990
self._parent_ids = []
1991
self._all_children_cache = {}
1992
self._path2trans_id_cache = {}
1993
self._final_name_cache = {}
1994
self._iter_changes_cache = dict((c[0], c) for c in
1995
self._transform.iter_changes())
1997
def _content_change(self, file_id):
1998
"""Return True if the content of this file changed"""
1999
changes = self._iter_changes_cache.get(file_id)
2000
# changes[2] is true if the file content changed. See
2001
# InterTree.iter_changes.
2002
return (changes is not None and changes[2])
2004
def _get_repository(self):
2005
repo = getattr(self._transform._tree, '_repository', None)
2007
repo = self._transform._tree.branch.repository
2010
def _iter_parent_trees(self):
2011
for revision_id in self.get_parent_ids():
2013
yield self.revision_tree(revision_id)
2014
except errors.NoSuchRevisionInTree:
2015
yield self._get_repository().revision_tree(revision_id)
2017
def _get_file_revision(self, file_id, vf, tree_revision):
2018
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
2019
self._iter_parent_trees()]
2020
vf.add_lines((file_id, tree_revision), parent_keys,
2021
self.get_file_lines(file_id))
2022
repo = self._get_repository()
2023
base_vf = repo.texts
2024
if base_vf not in vf.fallback_versionedfiles:
2025
vf.fallback_versionedfiles.append(base_vf)
2026
return tree_revision
2028
def _stat_limbo_file(self, file_id=None, trans_id=None):
2029
if trans_id is None:
2030
trans_id = self._transform.trans_id_file_id(file_id)
2031
name = self._transform._limbo_name(trans_id)
2032
return os.lstat(name)
2035
def _by_parent(self):
2036
if self.__by_parent is None:
2037
self.__by_parent = self._transform.by_parent()
2038
return self.__by_parent
2040
def _comparison_data(self, entry, path):
2041
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
2042
if kind == 'missing':
2046
file_id = self._transform.final_file_id(self._path2trans_id(path))
2047
executable = self.is_executable(file_id, path)
2048
return kind, executable, None
2050
def is_locked(self):
2053
def lock_read(self):
2054
# Perhaps in theory, this should lock the TreeTransform?
2061
def inventory(self):
2062
"""This Tree does not use inventory as its backing data."""
2063
raise NotImplementedError(_PreviewTree.inventory)
2065
def get_root_id(self):
2066
return self._transform.final_file_id(self._transform.root)
2068
def all_file_ids(self):
2069
tree_ids = set(self._transform._tree.all_file_ids())
2070
tree_ids.difference_update(self._transform.tree_file_id(t)
2071
for t in self._transform._removed_id)
2072
tree_ids.update(self._transform._new_id.values())
2076
return iter(self.all_file_ids())
2078
def _has_id(self, file_id, fallback_check):
2079
if file_id in self._transform._r_new_id:
2081
elif file_id in set([self._transform.tree_file_id(trans_id) for
2082
trans_id in self._transform._removed_id]):
2085
return fallback_check(file_id)
2087
def has_id(self, file_id):
2088
return self._has_id(file_id, self._transform._tree.has_id)
2090
def has_or_had_id(self, file_id):
2091
return self._has_id(file_id, self._transform._tree.has_or_had_id)
2093
def _path2trans_id(self, path):
2094
# We must not use None here, because that is a valid value to store.
2095
trans_id = self._path2trans_id_cache.get(path, object)
2096
if trans_id is not object:
2098
segments = splitpath(path)
2099
cur_parent = self._transform.root
2100
for cur_segment in segments:
2101
for child in self._all_children(cur_parent):
2102
final_name = self._final_name_cache.get(child)
2103
if final_name is None:
2104
final_name = self._transform.final_name(child)
2105
self._final_name_cache[child] = final_name
2106
if final_name == cur_segment:
2110
self._path2trans_id_cache[path] = None
2112
self._path2trans_id_cache[path] = cur_parent
2115
def path2id(self, path):
2116
return self._transform.final_file_id(self._path2trans_id(path))
2118
def id2path(self, file_id):
2119
trans_id = self._transform.trans_id_file_id(file_id)
2121
return self._final_paths._determine_path(trans_id)
2123
raise errors.NoSuchId(self, file_id)
2125
def _all_children(self, trans_id):
2126
children = self._all_children_cache.get(trans_id)
2127
if children is not None:
2129
children = set(self._transform.iter_tree_children(trans_id))
2130
# children in the _new_parent set are provided by _by_parent.
2131
children.difference_update(self._transform._new_parent.keys())
2132
children.update(self._by_parent.get(trans_id, []))
2133
self._all_children_cache[trans_id] = children
2136
def iter_children(self, file_id):
2137
trans_id = self._transform.trans_id_file_id(file_id)
2138
for child_trans_id in self._all_children(trans_id):
2139
yield self._transform.final_file_id(child_trans_id)
2142
possible_extras = set(self._transform.trans_id_tree_path(p) for p
2143
in self._transform._tree.extras())
2144
possible_extras.update(self._transform._new_contents)
2145
possible_extras.update(self._transform._removed_id)
2146
for trans_id in possible_extras:
2147
if self._transform.final_file_id(trans_id) is None:
2148
yield self._final_paths._determine_path(trans_id)
2150
def _make_inv_entries(self, ordered_entries, specific_file_ids=None,
2151
yield_parents=False):
2152
for trans_id, parent_file_id in ordered_entries:
2153
file_id = self._transform.final_file_id(trans_id)
2156
if (specific_file_ids is not None
2157
and file_id not in specific_file_ids):
2159
kind = self._transform.final_kind(trans_id)
2161
kind = self._transform._tree.stored_kind(file_id)
2162
new_entry = inventory.make_entry(
2164
self._transform.final_name(trans_id),
2165
parent_file_id, file_id)
2166
yield new_entry, trans_id
2168
def _list_files_by_dir(self):
2169
todo = [ROOT_PARENT]
2171
while len(todo) > 0:
2173
parent_file_id = self._transform.final_file_id(parent)
2174
children = list(self._all_children(parent))
2175
paths = dict(zip(children, self._final_paths.get_paths(children)))
2176
children.sort(key=paths.get)
2177
todo.extend(reversed(children))
2178
for trans_id in children:
2179
ordered_ids.append((trans_id, parent_file_id))
2182
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
2183
# This may not be a maximally efficient implementation, but it is
2184
# reasonably straightforward. An implementation that grafts the
2185
# TreeTransform changes onto the tree's iter_entries_by_dir results
2186
# might be more efficient, but requires tricky inferences about stack
2188
ordered_ids = self._list_files_by_dir()
2189
for entry, trans_id in self._make_inv_entries(ordered_ids,
2190
specific_file_ids, yield_parents=yield_parents):
2191
yield unicode(self._final_paths.get_path(trans_id)), entry
2193
def _iter_entries_for_dir(self, dir_path):
2194
"""Return path, entry for items in a directory without recursing down."""
2195
dir_file_id = self.path2id(dir_path)
2197
for file_id in self.iter_children(dir_file_id):
2198
trans_id = self._transform.trans_id_file_id(file_id)
2199
ordered_ids.append((trans_id, file_id))
2200
for entry, trans_id in self._make_inv_entries(ordered_ids):
2201
yield unicode(self._final_paths.get_path(trans_id)), entry
2203
def list_files(self, include_root=False, from_dir=None, recursive=True):
2204
"""See WorkingTree.list_files."""
2205
# XXX This should behave like WorkingTree.list_files, but is really
2206
# more like RevisionTree.list_files.
2210
prefix = from_dir + '/'
2211
entries = self.iter_entries_by_dir()
2212
for path, entry in entries:
2213
if entry.name == '' and not include_root:
2216
if not path.startswith(prefix):
2218
path = path[len(prefix):]
2219
yield path, 'V', entry.kind, entry.file_id, entry
2221
if from_dir is None and include_root is True:
2222
root_entry = inventory.make_entry('directory', '',
2223
ROOT_PARENT, self.get_root_id())
2224
yield '', 'V', 'directory', root_entry.file_id, root_entry
2225
entries = self._iter_entries_for_dir(from_dir or '')
2226
for path, entry in entries:
2227
yield path, 'V', entry.kind, entry.file_id, entry
2229
def kind(self, file_id):
2230
trans_id = self._transform.trans_id_file_id(file_id)
2231
return self._transform.final_kind(trans_id)
2233
def stored_kind(self, file_id):
2234
trans_id = self._transform.trans_id_file_id(file_id)
2236
return self._transform._new_contents[trans_id]
2238
return self._transform._tree.stored_kind(file_id)
2240
def get_file_mtime(self, file_id, path=None):
2241
"""See Tree.get_file_mtime"""
2242
if not self._content_change(file_id):
2243
return self._transform._tree.get_file_mtime(file_id)
2244
return self._stat_limbo_file(file_id).st_mtime
2246
def _file_size(self, entry, stat_value):
2247
return self.get_file_size(entry.file_id)
2249
def get_file_size(self, file_id):
2250
"""See Tree.get_file_size"""
2251
trans_id = self._transform.trans_id_file_id(file_id)
2252
kind = self._transform.final_kind(trans_id)
2255
if trans_id in self._transform._new_contents:
2256
return self._stat_limbo_file(trans_id=trans_id).st_size
2257
if self.kind(file_id) == 'file':
2258
return self._transform._tree.get_file_size(file_id)
2262
def get_file_verifier(self, file_id, path=None, stat_value=None):
2263
trans_id = self._transform.trans_id_file_id(file_id)
2264
kind = self._transform._new_contents.get(trans_id)
2266
return self._transform._tree.get_file_verifier(file_id)
2268
fileobj = self.get_file(file_id)
2270
return ("SHA1", sha_file(fileobj))
2274
def get_file_sha1(self, file_id, path=None, stat_value=None):
2275
trans_id = self._transform.trans_id_file_id(file_id)
2276
kind = self._transform._new_contents.get(trans_id)
2278
return self._transform._tree.get_file_sha1(file_id)
2280
fileobj = self.get_file(file_id)
2282
return sha_file(fileobj)
2286
def is_executable(self, file_id, path=None):
2289
trans_id = self._transform.trans_id_file_id(file_id)
2291
return self._transform._new_executability[trans_id]
2294
return self._transform._tree.is_executable(file_id, path)
2296
if e.errno == errno.ENOENT:
2299
except errors.NoSuchId:
2302
def has_filename(self, path):
2303
trans_id = self._path2trans_id(path)
2304
if trans_id in self._transform._new_contents:
2306
elif trans_id in self._transform._removed_contents:
2309
return self._transform._tree.has_filename(path)
2311
def path_content_summary(self, path):
2312
trans_id = self._path2trans_id(path)
2313
tt = self._transform
2314
tree_path = tt._tree_id_paths.get(trans_id)
2315
kind = tt._new_contents.get(trans_id)
2317
if tree_path is None or trans_id in tt._removed_contents:
2318
return 'missing', None, None, None
2319
summary = tt._tree.path_content_summary(tree_path)
2320
kind, size, executable, link_or_sha1 = summary
2323
limbo_name = tt._limbo_name(trans_id)
2324
if trans_id in tt._new_reference_revision:
2325
kind = 'tree-reference'
2327
statval = os.lstat(limbo_name)
2328
size = statval.st_size
2329
if not tt._limbo_supports_executable():
2332
executable = statval.st_mode & S_IEXEC
2336
if kind == 'symlink':
2337
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
2338
executable = tt._new_executability.get(trans_id, executable)
2339
return kind, size, executable, link_or_sha1
2341
def iter_changes(self, from_tree, include_unchanged=False,
2342
specific_files=None, pb=None, extra_trees=None,
2343
require_versioned=True, want_unversioned=False):
2344
"""See InterTree.iter_changes.
2346
This has a fast path that is only used when the from_tree matches
2347
the transform tree, and no fancy options are supplied.
2349
if (from_tree is not self._transform._tree or include_unchanged or
2350
specific_files or want_unversioned):
2351
return tree.InterTree(from_tree, self).iter_changes(
2352
include_unchanged=include_unchanged,
2353
specific_files=specific_files,
2355
extra_trees=extra_trees,
2356
require_versioned=require_versioned,
2357
want_unversioned=want_unversioned)
2358
if want_unversioned:
2359
raise ValueError('want_unversioned is not supported')
2360
return self._transform.iter_changes()
2362
def get_file(self, file_id, path=None):
2363
"""See Tree.get_file"""
2364
if not self._content_change(file_id):
2365
return self._transform._tree.get_file(file_id, path)
2366
trans_id = self._transform.trans_id_file_id(file_id)
2367
name = self._transform._limbo_name(trans_id)
2368
return open(name, 'rb')
2370
def get_file_with_stat(self, file_id, path=None):
2371
return self.get_file(file_id, path), None
2373
def annotate_iter(self, file_id,
2374
default_revision=_mod_revision.CURRENT_REVISION):
2375
changes = self._iter_changes_cache.get(file_id)
2379
changed_content, versioned, kind = (changes[2], changes[3],
2383
get_old = (kind[0] == 'file' and versioned[0])
2385
old_annotation = self._transform._tree.annotate_iter(file_id,
2386
default_revision=default_revision)
2390
return old_annotation
2391
if not changed_content:
2392
return old_annotation
2393
# TODO: This is doing something similar to what WT.annotate_iter is
2394
# doing, however it fails slightly because it doesn't know what
2395
# the *other* revision_id is, so it doesn't know how to give the
2396
# other as the origin for some lines, they all get
2397
# 'default_revision'
2398
# It would be nice to be able to use the new Annotator based
2399
# approach, as well.
2400
return annotate.reannotate([old_annotation],
2401
self.get_file(file_id).readlines(),
2404
def get_symlink_target(self, file_id, path=None):
2405
"""See Tree.get_symlink_target"""
2406
if not self._content_change(file_id):
2407
return self._transform._tree.get_symlink_target(file_id)
2408
trans_id = self._transform.trans_id_file_id(file_id)
2409
name = self._transform._limbo_name(trans_id)
2410
return osutils.readlink(name)
2412
def walkdirs(self, prefix=''):
2413
pending = [self._transform.root]
2414
while len(pending) > 0:
2415
parent_id = pending.pop()
2418
prefix = prefix.rstrip('/')
2419
parent_path = self._final_paths.get_path(parent_id)
2420
parent_file_id = self._transform.final_file_id(parent_id)
2421
for child_id in self._all_children(parent_id):
2422
path_from_root = self._final_paths.get_path(child_id)
2423
basename = self._transform.final_name(child_id)
2424
file_id = self._transform.final_file_id(child_id)
2425
kind = self._transform.final_kind(child_id)
2426
if kind is not None:
2427
versioned_kind = kind
2430
versioned_kind = self._transform._tree.stored_kind(file_id)
2431
if versioned_kind == 'directory':
2432
subdirs.append(child_id)
2433
children.append((path_from_root, basename, kind, None,
2434
file_id, versioned_kind))
2436
if parent_path.startswith(prefix):
2437
yield (parent_path, parent_file_id), children
2438
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
2441
def get_parent_ids(self):
2442
return self._parent_ids
2444
def set_parent_ids(self, parent_ids):
2445
self._parent_ids = parent_ids
2447
def get_revision_tree(self, revision_id):
2448
return self._transform._tree.get_revision_tree(revision_id)
2451
def joinpath(parent, child):
2452
"""Join tree-relative paths, handling the tree root specially"""
2453
if parent is None or parent == "":
2456
return pathjoin(parent, child)
2459
class FinalPaths(object):
2460
"""Make path calculation cheap by memoizing paths.
2462
The underlying tree must not be manipulated between calls, or else
2463
the results will likely be incorrect.
2465
def __init__(self, transform):
2466
object.__init__(self)
2467
self._known_paths = {}
2468
self.transform = transform
2470
def _determine_path(self, trans_id):
2471
if (trans_id == self.transform.root or trans_id == ROOT_PARENT):
2473
name = self.transform.final_name(trans_id)
2474
parent_id = self.transform.final_parent(trans_id)
2475
if parent_id == self.transform.root:
2478
return pathjoin(self.get_path(parent_id), name)
2480
def get_path(self, trans_id):
2481
"""Find the final path associated with a trans_id"""
2482
if trans_id not in self._known_paths:
2483
self._known_paths[trans_id] = self._determine_path(trans_id)
2484
return self._known_paths[trans_id]
2486
def get_paths(self, trans_ids):
2487
return [(self.get_path(t), t) for t in trans_ids]
2491
def topology_sorted_ids(tree):
2492
"""Determine the topological order of the ids in a tree"""
2493
file_ids = list(tree)
2494
file_ids.sort(key=tree.id2path)
2498
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2499
delta_from_tree=False):
2500
"""Create working tree for a branch, using a TreeTransform.
2502
This function should be used on empty trees, having a tree root at most.
2503
(see merge and revert functionality for working with existing trees)
2505
Existing files are handled like so:
2507
- Existing bzrdirs take precedence over creating new items. They are
2508
created as '%s.diverted' % name.
2509
- Otherwise, if the content on disk matches the content we are building,
2510
it is silently replaced.
2511
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2513
:param tree: The tree to convert wt into a copy of
2514
:param wt: The working tree that files will be placed into
2515
:param accelerator_tree: A tree which can be used for retrieving file
2516
contents more quickly than tree itself, i.e. a workingtree. tree
2517
will be used for cases where accelerator_tree's content is different.
2518
:param hardlink: If true, hard-link files to accelerator_tree, where
2519
possible. accelerator_tree must implement abspath, i.e. be a
2521
:param delta_from_tree: If true, build_tree may use the input Tree to
2522
generate the inventory delta.
2524
wt.lock_tree_write()
2528
if accelerator_tree is not None:
2529
accelerator_tree.lock_read()
2531
return _build_tree(tree, wt, accelerator_tree, hardlink,
2534
if accelerator_tree is not None:
2535
accelerator_tree.unlock()
2542
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2543
"""See build_tree."""
2544
for num, _unused in enumerate(wt.all_file_ids()):
2545
if num > 0: # more than just a root
2546
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2548
top_pb = ui.ui_factory.nested_progress_bar()
2549
pp = ProgressPhase("Build phase", 2, top_pb)
2550
if tree.get_root_id() is not None:
2551
# This is kind of a hack: we should be altering the root
2552
# as part of the regular tree shape diff logic.
2553
# The conditional test here is to avoid doing an
2554
# expensive operation (flush) every time the root id
2555
# is set within the tree, nor setting the root and thus
2556
# marking the tree as dirty, because we use two different
2557
# idioms here: tree interfaces and inventory interfaces.
2558
if wt.get_root_id() != tree.get_root_id():
2559
wt.set_root_id(tree.get_root_id())
2561
tt = TreeTransform(wt)
2565
file_trans_id[wt.get_root_id()] = \
2566
tt.trans_id_tree_file_id(wt.get_root_id())
2567
pb = ui.ui_factory.nested_progress_bar()
2569
deferred_contents = []
2571
total = len(tree.all_file_ids())
2573
precomputed_delta = []
2575
precomputed_delta = None
2576
# Check if tree inventory has content. If so, we populate
2577
# existing_files with the directory content. If there are no
2578
# entries we skip populating existing_files as its not used.
2579
# This improves performance and unncessary work on large
2580
# directory trees. (#501307)
2582
existing_files = set()
2583
for dir, files in wt.walkdirs():
2584
existing_files.update(f[0] for f in files)
2585
for num, (tree_path, entry) in \
2586
enumerate(tree.iter_entries_by_dir()):
2587
pb.update(gettext("Building tree"), num - len(deferred_contents), total)
2588
if entry.parent_id is None:
2591
file_id = entry.file_id
2593
precomputed_delta.append((None, tree_path, file_id, entry))
2594
if tree_path in existing_files:
2595
target_path = wt.abspath(tree_path)
2596
kind = file_kind(target_path)
2597
if kind == "directory":
2599
controldir.ControlDir.open(target_path)
2600
except errors.NotBranchError:
2604
if (file_id not in divert and
2605
_content_match(tree, entry, file_id, kind,
2607
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2608
if kind == 'directory':
2610
parent_id = file_trans_id[entry.parent_id]
2611
if entry.kind == 'file':
2612
# We *almost* replicate new_by_entry, so that we can defer
2613
# getting the file text, and get them all at once.
2614
trans_id = tt.create_path(entry.name, parent_id)
2615
file_trans_id[file_id] = trans_id
2616
tt.version_file(file_id, trans_id)
2617
executable = tree.is_executable(file_id, tree_path)
2619
tt.set_executability(executable, trans_id)
2620
trans_data = (trans_id, tree_path, entry.text_sha1)
2621
deferred_contents.append((file_id, trans_data))
2623
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2626
new_trans_id = file_trans_id[file_id]
2627
old_parent = tt.trans_id_tree_path(tree_path)
2628
_reparent_children(tt, old_parent, new_trans_id)
2629
offset = num + 1 - len(deferred_contents)
2630
_create_files(tt, tree, deferred_contents, pb, offset,
2631
accelerator_tree, hardlink)
2635
divert_trans = set(file_trans_id[f] for f in divert)
2636
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2637
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2638
if len(raw_conflicts) > 0:
2639
precomputed_delta = None
2640
conflicts = cook_conflicts(raw_conflicts, tt)
2641
for conflict in conflicts:
2642
trace.warning(unicode(conflict))
2644
wt.add_conflicts(conflicts)
2645
except errors.UnsupportedOperation:
2647
result = tt.apply(no_conflicts=True,
2648
precomputed_delta=precomputed_delta)
2655
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2657
total = len(desired_files) + offset
2659
if accelerator_tree is None:
2660
new_desired_files = desired_files
2662
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2663
unchanged = [(f, p[1]) for (f, p, c, v, d, n, k, e)
2664
in iter if not (c or e[0] != e[1])]
2665
if accelerator_tree.supports_content_filtering():
2666
unchanged = [(f, p) for (f, p) in unchanged
2667
if not accelerator_tree.iter_search_rules([p]).next()]
2668
unchanged = dict(unchanged)
2669
new_desired_files = []
2671
for file_id, (trans_id, tree_path, text_sha1) in desired_files:
2672
accelerator_path = unchanged.get(file_id)
2673
if accelerator_path is None:
2674
new_desired_files.append((file_id,
2675
(trans_id, tree_path, text_sha1)))
2677
pb.update(gettext('Adding file contents'), count + offset, total)
2679
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2682
contents = accelerator_tree.get_file(file_id, accelerator_path)
2683
if wt.supports_content_filtering():
2684
filters = wt._content_filter_stack(tree_path)
2685
contents = filtered_output_bytes(contents, filters,
2686
ContentFilterContext(tree_path, tree))
2688
tt.create_file(contents, trans_id, sha1=text_sha1)
2692
except AttributeError:
2693
# after filtering, contents may no longer be file-like
2697
for count, ((trans_id, tree_path, text_sha1), contents) in enumerate(
2698
tree.iter_files_bytes(new_desired_files)):
2699
if wt.supports_content_filtering():
2700
filters = wt._content_filter_stack(tree_path)
2701
contents = filtered_output_bytes(contents, filters,
2702
ContentFilterContext(tree_path, tree))
2703
tt.create_file(contents, trans_id, sha1=text_sha1)
2704
pb.update(gettext('Adding file contents'), count + offset, total)
2707
def _reparent_children(tt, old_parent, new_parent):
2708
for child in tt.iter_tree_children(old_parent):
2709
tt.adjust_path(tt.final_name(child), new_parent, child)
2712
def _reparent_transform_children(tt, old_parent, new_parent):
2713
by_parent = tt.by_parent()
2714
for child in by_parent[old_parent]:
2715
tt.adjust_path(tt.final_name(child), new_parent, child)
2716
return by_parent[old_parent]
2719
def _content_match(tree, entry, file_id, kind, target_path):
2720
if entry.kind != kind:
2722
if entry.kind == "directory":
2724
if entry.kind == "file":
2725
f = file(target_path, 'rb')
2727
if tree.get_file_text(file_id) == f.read():
2731
elif entry.kind == "symlink":
2732
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2737
def resolve_checkout(tt, conflicts, divert):
2738
new_conflicts = set()
2739
for c_type, conflict in ((c[0], c) for c in conflicts):
2740
# Anything but a 'duplicate' would indicate programmer error
2741
if c_type != 'duplicate':
2742
raise AssertionError(c_type)
2743
# Now figure out which is new and which is old
2744
if tt.new_contents(conflict[1]):
2745
new_file = conflict[1]
2746
old_file = conflict[2]
2748
new_file = conflict[2]
2749
old_file = conflict[1]
2751
# We should only get here if the conflict wasn't completely
2753
final_parent = tt.final_parent(old_file)
2754
if new_file in divert:
2755
new_name = tt.final_name(old_file)+'.diverted'
2756
tt.adjust_path(new_name, final_parent, new_file)
2757
new_conflicts.add((c_type, 'Diverted to',
2758
new_file, old_file))
2760
new_name = tt.final_name(old_file)+'.moved'
2761
tt.adjust_path(new_name, final_parent, old_file)
2762
new_conflicts.add((c_type, 'Moved existing file to',
2763
old_file, new_file))
2764
return new_conflicts
2767
def new_by_entry(tt, entry, parent_id, tree):
2768
"""Create a new file according to its inventory entry"""
2772
contents = tree.get_file(entry.file_id).readlines()
2773
executable = tree.is_executable(entry.file_id)
2774
return tt.new_file(name, parent_id, contents, entry.file_id,
2776
elif kind in ('directory', 'tree-reference'):
2777
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2778
if kind == 'tree-reference':
2779
tt.set_tree_reference(entry.reference_revision, trans_id)
2781
elif kind == 'symlink':
2782
target = tree.get_symlink_target(entry.file_id)
2783
return tt.new_symlink(name, parent_id, target, entry.file_id)
2785
raise errors.BadFileKindError(name, kind)
2788
def create_from_tree(tt, trans_id, tree, file_id, bytes=None,
2789
filter_tree_path=None):
2790
"""Create new file contents according to tree contents.
2792
:param filter_tree_path: the tree path to use to lookup
2793
content filters to apply to the bytes output in the working tree.
2794
This only applies if the working tree supports content filtering.
2796
kind = tree.kind(file_id)
2797
if kind == 'directory':
2798
tt.create_directory(trans_id)
2799
elif kind == "file":
2801
tree_file = tree.get_file(file_id)
2803
bytes = tree_file.readlines()
2807
if wt.supports_content_filtering() and filter_tree_path is not None:
2808
filters = wt._content_filter_stack(filter_tree_path)
2809
bytes = filtered_output_bytes(bytes, filters,
2810
ContentFilterContext(filter_tree_path, tree))
2811
tt.create_file(bytes, trans_id)
2812
elif kind == "symlink":
2813
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2815
raise AssertionError('Unknown kind %r' % kind)
2818
def create_entry_executability(tt, entry, trans_id):
2819
"""Set the executability of a trans_id according to an inventory entry"""
2820
if entry.kind == "file":
2821
tt.set_executability(entry.executable, trans_id)
2824
@deprecated_function(deprecated_in((2, 3, 0)))
2825
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2826
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2829
@deprecated_function(deprecated_in((2, 3, 0)))
2830
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2831
"""Produce a backup-style name that appears to be available"""
2835
yield "%s.~%d~" % (name, counter)
2837
for new_name in name_gen():
2838
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2842
def revert(working_tree, target_tree, filenames, backups=False,
2843
pb=None, change_reporter=None):
2844
"""Revert a working tree's contents to those of a target tree."""
2845
target_tree.lock_read()
2846
pb = ui.ui_factory.nested_progress_bar()
2847
tt = TreeTransform(working_tree, pb)
2849
pp = ProgressPhase("Revert phase", 3, pb)
2850
conflicts, merge_modified = _prepare_revert_transform(
2851
working_tree, target_tree, tt, filenames, backups, pp)
2853
change_reporter = delta._ChangeReporter(
2854
unversioned_filter=working_tree.is_ignored)
2855
delta.report_changes(tt.iter_changes(), change_reporter)
2856
for conflict in conflicts:
2857
trace.warning(unicode(conflict))
2860
working_tree.set_merge_modified(merge_modified)
2862
target_tree.unlock()
2868
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2869
backups, pp, basis_tree=None,
2870
merge_modified=None):
2871
child_pb = ui.ui_factory.nested_progress_bar()
2873
if merge_modified is None:
2874
merge_modified = working_tree.merge_modified()
2875
merge_modified = _alter_files(working_tree, target_tree, tt,
2876
child_pb, filenames, backups,
2877
merge_modified, basis_tree)
2880
child_pb = ui.ui_factory.nested_progress_bar()
2882
raw_conflicts = resolve_conflicts(tt, child_pb,
2883
lambda t, c: conflict_pass(t, c, target_tree))
2886
conflicts = cook_conflicts(raw_conflicts, tt)
2887
return conflicts, merge_modified
2890
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2891
backups, merge_modified, basis_tree=None):
2892
if basis_tree is not None:
2893
basis_tree.lock_read()
2894
# We ask the working_tree for its changes relative to the target, rather
2895
# than the target changes relative to the working tree. Because WT4 has an
2896
# optimizer to compare itself to a target, but no optimizer for the
2898
change_list = working_tree.iter_changes(target_tree,
2899
specific_files=specific_files, pb=pb)
2900
if target_tree.get_root_id() is None:
2906
for id_num, (file_id, path, changed_content, versioned, parent, name,
2907
kind, executable) in enumerate(change_list):
2908
target_path, wt_path = path
2909
target_versioned, wt_versioned = versioned
2910
target_parent, wt_parent = parent
2911
target_name, wt_name = name
2912
target_kind, wt_kind = kind
2913
target_executable, wt_executable = executable
2914
if skip_root and wt_parent is None:
2916
trans_id = tt.trans_id_file_id(file_id)
2919
keep_content = False
2920
if wt_kind == 'file' and (backups or target_kind is None):
2921
wt_sha1 = working_tree.get_file_sha1(file_id)
2922
if merge_modified.get(file_id) != wt_sha1:
2923
# acquire the basis tree lazily to prevent the
2924
# expense of accessing it when it's not needed ?
2925
# (Guessing, RBC, 200702)
2926
if basis_tree is None:
2927
basis_tree = working_tree.basis_tree()
2928
basis_tree.lock_read()
2929
if basis_tree.has_id(file_id):
2930
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2932
elif target_kind is None and not target_versioned:
2934
if wt_kind is not None:
2935
if not keep_content:
2936
tt.delete_contents(trans_id)
2937
elif target_kind is not None:
2938
parent_trans_id = tt.trans_id_file_id(wt_parent)
2939
backup_name = tt._available_backup_name(
2940
wt_name, parent_trans_id)
2941
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2942
new_trans_id = tt.create_path(wt_name, parent_trans_id)
2943
if wt_versioned and target_versioned:
2944
tt.unversion_file(trans_id)
2945
tt.version_file(file_id, new_trans_id)
2946
# New contents should have the same unix perms as old
2949
trans_id = new_trans_id
2950
if target_kind in ('directory', 'tree-reference'):
2951
tt.create_directory(trans_id)
2952
if target_kind == 'tree-reference':
2953
revision = target_tree.get_reference_revision(file_id,
2955
tt.set_tree_reference(revision, trans_id)
2956
elif target_kind == 'symlink':
2957
tt.create_symlink(target_tree.get_symlink_target(file_id),
2959
elif target_kind == 'file':
2960
deferred_files.append((file_id, (trans_id, mode_id)))
2961
if basis_tree is None:
2962
basis_tree = working_tree.basis_tree()
2963
basis_tree.lock_read()
2964
new_sha1 = target_tree.get_file_sha1(file_id)
2965
if (basis_tree.has_id(file_id) and
2966
new_sha1 == basis_tree.get_file_sha1(file_id)):
2967
if file_id in merge_modified:
2968
del merge_modified[file_id]
2970
merge_modified[file_id] = new_sha1
2972
# preserve the execute bit when backing up
2973
if keep_content and wt_executable == target_executable:
2974
tt.set_executability(target_executable, trans_id)
2975
elif target_kind is not None:
2976
raise AssertionError(target_kind)
2977
if not wt_versioned and target_versioned:
2978
tt.version_file(file_id, trans_id)
2979
if wt_versioned and not target_versioned:
2980
tt.unversion_file(trans_id)
2981
if (target_name is not None and
2982
(wt_name != target_name or wt_parent != target_parent)):
2983
if target_name == '' and target_parent is None:
2984
parent_trans = ROOT_PARENT
2986
parent_trans = tt.trans_id_file_id(target_parent)
2987
if wt_parent is None and wt_versioned:
2988
tt.adjust_root_path(target_name, parent_trans)
2990
tt.adjust_path(target_name, parent_trans, trans_id)
2991
if wt_executable != target_executable and target_kind == "file":
2992
tt.set_executability(target_executable, trans_id)
2993
if working_tree.supports_content_filtering():
2994
for index, ((trans_id, mode_id), bytes) in enumerate(
2995
target_tree.iter_files_bytes(deferred_files)):
2996
file_id = deferred_files[index][0]
2997
# We're reverting a tree to the target tree so using the
2998
# target tree to find the file path seems the best choice
2999
# here IMO - Ian C 27/Oct/2009
3000
filter_tree_path = target_tree.id2path(file_id)
3001
filters = working_tree._content_filter_stack(filter_tree_path)
3002
bytes = filtered_output_bytes(bytes, filters,
3003
ContentFilterContext(filter_tree_path, working_tree))
3004
tt.create_file(bytes, trans_id, mode_id)
3006
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
3008
tt.create_file(bytes, trans_id, mode_id)
3009
tt.fixup_new_roots()
3011
if basis_tree is not None:
3013
return merge_modified
3016
def resolve_conflicts(tt, pb=None, pass_func=None):
3017
"""Make many conflict-resolution attempts, but die if they fail"""
3018
if pass_func is None:
3019
pass_func = conflict_pass
3020
new_conflicts = set()
3021
pb = ui.ui_factory.nested_progress_bar()
3024
pb.update(gettext('Resolution pass'), n+1, 10)
3025
conflicts = tt.find_conflicts()
3026
if len(conflicts) == 0:
3027
return new_conflicts
3028
new_conflicts.update(pass_func(tt, conflicts))
3029
raise MalformedTransform(conflicts=conflicts)
3034
def conflict_pass(tt, conflicts, path_tree=None):
3035
"""Resolve some classes of conflicts.
3037
:param tt: The transform to resolve conflicts in
3038
:param conflicts: The conflicts to resolve
3039
:param path_tree: A Tree to get supplemental paths from
3041
new_conflicts = set()
3042
for c_type, conflict in ((c[0], c) for c in conflicts):
3043
if c_type == 'duplicate id':
3044
tt.unversion_file(conflict[1])
3045
new_conflicts.add((c_type, 'Unversioned existing file',
3046
conflict[1], conflict[2], ))
3047
elif c_type == 'duplicate':
3048
# files that were renamed take precedence
3049
final_parent = tt.final_parent(conflict[1])
3050
if tt.path_changed(conflict[1]):
3051
existing_file, new_file = conflict[2], conflict[1]
3053
existing_file, new_file = conflict[1], conflict[2]
3054
new_name = tt.final_name(existing_file) + '.moved'
3055
tt.adjust_path(new_name, final_parent, existing_file)
3056
new_conflicts.add((c_type, 'Moved existing file to',
3057
existing_file, new_file))
3058
elif c_type == 'parent loop':
3059
# break the loop by undoing one of the ops that caused the loop
3061
while not tt.path_changed(cur):
3062
cur = tt.final_parent(cur)
3063
new_conflicts.add((c_type, 'Cancelled move', cur,
3064
tt.final_parent(cur),))
3065
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
3067
elif c_type == 'missing parent':
3068
trans_id = conflict[1]
3069
if trans_id in tt._removed_contents:
3070
cancel_deletion = True
3071
orphans = tt._get_potential_orphans(trans_id)
3073
cancel_deletion = False
3074
# All children are orphans
3077
tt.new_orphan(o, trans_id)
3078
except OrphaningError:
3079
# Something bad happened so we cancel the directory
3080
# deletion which will leave it in place with a
3081
# conflict. The user can deal with it from there.
3082
# Note that this also catch the case where we don't
3083
# want to create orphans and leave the directory in
3085
cancel_deletion = True
3088
# Cancel the directory deletion
3089
tt.cancel_deletion(trans_id)
3090
new_conflicts.add(('deleting parent', 'Not deleting',
3095
tt.final_name(trans_id)
3097
if path_tree is not None:
3098
file_id = tt.final_file_id(trans_id)
3100
file_id = tt.inactive_file_id(trans_id)
3101
_, entry = path_tree.iter_entries_by_dir(
3103
# special-case the other tree root (move its
3104
# children to current root)
3105
if entry.parent_id is None:
3107
moved = _reparent_transform_children(
3108
tt, trans_id, tt.root)
3110
new_conflicts.add((c_type, 'Moved to root',
3113
parent_trans_id = tt.trans_id_file_id(
3115
tt.adjust_path(entry.name, parent_trans_id,
3118
tt.create_directory(trans_id)
3119
new_conflicts.add((c_type, 'Created directory', trans_id))
3120
elif c_type == 'unversioned parent':
3121
file_id = tt.inactive_file_id(conflict[1])
3122
# special-case the other tree root (move its children instead)
3123
if path_tree and path_tree.has_id(file_id):
3124
if path_tree.path2id('') == file_id:
3125
# This is the root entry, skip it
3127
tt.version_file(file_id, conflict[1])
3128
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
3129
elif c_type == 'non-directory parent':
3130
parent_id = conflict[1]
3131
parent_parent = tt.final_parent(parent_id)
3132
parent_name = tt.final_name(parent_id)
3133
parent_file_id = tt.final_file_id(parent_id)
3134
new_parent_id = tt.new_directory(parent_name + '.new',
3135
parent_parent, parent_file_id)
3136
_reparent_transform_children(tt, parent_id, new_parent_id)
3137
if parent_file_id is not None:
3138
tt.unversion_file(parent_id)
3139
new_conflicts.add((c_type, 'Created directory', new_parent_id))
3140
elif c_type == 'versioning no contents':
3141
tt.cancel_versioning(conflict[1])
3142
return new_conflicts
3145
def cook_conflicts(raw_conflicts, tt):
3146
"""Generate a list of cooked conflicts, sorted by file path"""
3147
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
3148
return sorted(conflict_iter, key=conflicts.Conflict.sort_key)
3151
def iter_cook_conflicts(raw_conflicts, tt):
3153
for conflict in raw_conflicts:
3154
c_type = conflict[0]
3155
action = conflict[1]
3156
modified_path = fp.get_path(conflict[2])
3157
modified_id = tt.final_file_id(conflict[2])
3158
if len(conflict) == 3:
3159
yield conflicts.Conflict.factory(
3160
c_type, action=action, path=modified_path, file_id=modified_id)
3163
conflicting_path = fp.get_path(conflict[3])
3164
conflicting_id = tt.final_file_id(conflict[3])
3165
yield conflicts.Conflict.factory(
3166
c_type, action=action, path=modified_path,
3167
file_id=modified_id,
3168
conflict_path=conflicting_path,
3169
conflict_file_id=conflicting_id)
3172
class _FileMover(object):
3173
"""Moves and deletes files for TreeTransform, tracking operations"""
3176
self.past_renames = []
3177
self.pending_deletions = []
3179
def rename(self, from_, to):
3180
"""Rename a file from one path to another."""
3182
os.rename(from_, to)
3184
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
3185
raise errors.FileExists(to, str(e))
3186
# normal OSError doesn't include filenames so it's hard to see where
3187
# the problem is, see https://bugs.launchpad.net/bzr/+bug/491763
3188
raise errors.TransformRenameFailed(from_, to, str(e), e.errno)
3189
self.past_renames.append((from_, to))
3191
def pre_delete(self, from_, to):
3192
"""Rename a file out of the way and mark it for deletion.
3194
Unlike os.unlink, this works equally well for files and directories.
3195
:param from_: The current file path
3196
:param to: A temporary path for the file
3198
self.rename(from_, to)
3199
self.pending_deletions.append(to)
3202
"""Reverse all renames that have been performed"""
3203
for from_, to in reversed(self.past_renames):
3205
os.rename(to, from_)
3207
raise errors.TransformRenameFailed(to, from_, str(e), e.errno)
3208
# after rollback, don't reuse _FileMover
3210
pending_deletions = None
3212
def apply_deletions(self):
3213
"""Apply all marked deletions"""
3214
for path in self.pending_deletions:
3216
# after apply_deletions, don't reuse _FileMover
3218
pending_deletions = None
added
removed
bzrlib/transform.py
