1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from stat import S_ISREG, S_IEXEC
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
32
revision as _mod_revision,
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
36
ReusingTransform, NotVersionedError, CantMoveRoot,
37
ExistingLimbo, ImmortalLimbo, NoFinalPath,
39
from bzrlib.filters import filtered_output_bytes, ContentFilterContext
40
from bzrlib.inventory import InventoryEntry
41
from bzrlib.osutils import (
51
from bzrlib.progress import DummyProgress, ProgressPhase
52
from bzrlib.symbol_versioning import (
56
from bzrlib.trace import mutter, warning
57
from bzrlib import tree
59
import bzrlib.urlutils as urlutils
62
ROOT_PARENT = "root-parent"
65
def unique_add(map, key, value):
67
raise DuplicateKey(key=key)
71
class _TransformResults(object):
72
def __init__(self, modified_paths, rename_count):
74
self.modified_paths = modified_paths
75
self.rename_count = rename_count
78
class TreeTransformBase(object):
79
"""The base class for TreeTransform and TreeTransformBase"""
81
def __init__(self, tree, limbodir, pb=DummyProgress(),
85
:param tree: The tree that will be transformed, but not necessarily
87
:param limbodir: A directory where new files can be stored until
88
they are installed in their proper places
89
:param pb: A ProgressBar indicating how much progress is being made
90
:param case_sensitive: If True, the target of the transform is
91
case sensitive, not just case preserving.
95
self._limbodir = limbodir
96
self._deletiondir = None
98
# mapping of trans_id -> new basename
100
# mapping of trans_id -> new parent trans_id
101
self._new_parent = {}
102
# mapping of trans_id with new contents -> new file_kind
103
self._new_contents = {}
104
# A mapping of transform ids to their limbo filename
105
self._limbo_files = {}
106
# A mapping of transform ids to a set of the transform ids of children
107
# that their limbo directory has
108
self._limbo_children = {}
109
# Map transform ids to maps of child filename to child transform id
110
self._limbo_children_names = {}
111
# List of transform ids that need to be renamed from limbo into place
112
self._needs_rename = set()
113
# Set of trans_ids whose contents will be removed
114
self._removed_contents = set()
115
# Mapping of trans_id -> new execute-bit value
116
self._new_executability = {}
117
# Mapping of trans_id -> new tree-reference value
118
self._new_reference_revision = {}
119
# Mapping of trans_id -> new file_id
121
# Mapping of old file-id -> trans_id
122
self._non_present_ids = {}
123
# Mapping of new file_id -> trans_id
125
# Set of trans_ids that will be removed
126
self._removed_id = set()
127
# Mapping of path in old tree -> trans_id
128
self._tree_path_ids = {}
129
# Mapping trans_id -> path in old tree
130
self._tree_id_paths = {}
131
# Cache of realpath results, to speed up canonical_path
133
# Cache of relpath results, to speed up canonical_path
135
# The trans_id that will be used as the tree root
136
root_id = tree.get_root_id()
137
if root_id is not None:
138
self._new_root = self.trans_id_tree_file_id(root_id)
140
self._new_root = None
141
# Indictor of whether the transform has been applied
145
# Whether the target is case sensitive
146
self._case_sensitive_target = case_sensitive
147
# A counter of how many files have been renamed
148
self.rename_count = 0
150
def __get_root(self):
151
return self._new_root
153
root = property(__get_root)
156
"""Release the working tree lock, if held, clean up limbo dir.
158
This is required if apply has not been invoked, but can be invoked
161
if self._tree is None:
164
entries = [(self._limbo_name(t), t, k) for t, k in
165
self._new_contents.iteritems()]
166
entries.sort(reverse=True)
167
for path, trans_id, kind in entries:
168
if kind == "directory":
173
os.rmdir(self._limbodir)
175
# We don't especially care *why* the dir is immortal.
176
raise ImmortalLimbo(self._limbodir)
178
if self._deletiondir is not None:
179
os.rmdir(self._deletiondir)
181
raise errors.ImmortalPendingDeletion(self._deletiondir)
186
def _assign_id(self):
187
"""Produce a new tranform id"""
188
new_id = "new-%s" % self._id_number
192
def create_path(self, name, parent):
193
"""Assign a transaction id to a new path"""
194
trans_id = self._assign_id()
195
unique_add(self._new_name, trans_id, name)
196
unique_add(self._new_parent, trans_id, parent)
199
def adjust_path(self, name, parent, trans_id):
200
"""Change the path that is assigned to a transaction id."""
201
if trans_id == self._new_root:
203
previous_parent = self._new_parent.get(trans_id)
204
previous_name = self._new_name.get(trans_id)
205
self._new_name[trans_id] = name
206
self._new_parent[trans_id] = parent
207
if parent == ROOT_PARENT:
208
if self._new_root is not None:
209
raise ValueError("Cannot have multiple roots.")
210
self._new_root = trans_id
211
if (trans_id in self._limbo_files and
212
trans_id not in self._needs_rename):
213
self._rename_in_limbo([trans_id])
214
self._limbo_children[previous_parent].remove(trans_id)
215
del self._limbo_children_names[previous_parent][previous_name]
217
def _rename_in_limbo(self, trans_ids):
218
"""Fix limbo names so that the right final path is produced.
220
This means we outsmarted ourselves-- we tried to avoid renaming
221
these files later by creating them with their final names in their
222
final parents. But now the previous name or parent is no longer
223
suitable, so we have to rename them.
225
Even for trans_ids that have no new contents, we must remove their
226
entries from _limbo_files, because they are now stale.
228
for trans_id in trans_ids:
229
old_path = self._limbo_files.pop(trans_id)
230
if trans_id not in self._new_contents:
232
new_path = self._limbo_name(trans_id)
233
os.rename(old_path, new_path)
235
def adjust_root_path(self, name, parent):
236
"""Emulate moving the root by moving all children, instead.
238
We do this by undoing the association of root's transaction id with the
239
current tree. This allows us to create a new directory with that
240
transaction id. We unversion the root directory and version the
241
physically new directory, and hope someone versions the tree root
244
old_root = self._new_root
245
old_root_file_id = self.final_file_id(old_root)
246
# force moving all children of root
247
for child_id in self.iter_tree_children(old_root):
248
if child_id != parent:
249
self.adjust_path(self.final_name(child_id),
250
self.final_parent(child_id), child_id)
251
file_id = self.final_file_id(child_id)
252
if file_id is not None:
253
self.unversion_file(child_id)
254
self.version_file(file_id, child_id)
256
# the physical root needs a new transaction id
257
self._tree_path_ids.pop("")
258
self._tree_id_paths.pop(old_root)
259
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
260
if parent == old_root:
261
parent = self._new_root
262
self.adjust_path(name, parent, old_root)
263
self.create_directory(old_root)
264
self.version_file(old_root_file_id, old_root)
265
self.unversion_file(self._new_root)
267
def trans_id_tree_file_id(self, inventory_id):
268
"""Determine the transaction id of a working tree file.
270
This reflects only files that already exist, not ones that will be
271
added by transactions.
273
if inventory_id is None:
274
raise ValueError('None is not a valid file id')
275
path = self._tree.id2path(inventory_id)
276
return self.trans_id_tree_path(path)
278
def trans_id_file_id(self, file_id):
279
"""Determine or set the transaction id associated with a file ID.
280
A new id is only created for file_ids that were never present. If
281
a transaction has been unversioned, it is deliberately still returned.
282
(this will likely lead to an unversioned parent conflict.)
285
raise ValueError('None is not a valid file id')
286
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
287
return self._r_new_id[file_id]
290
self._tree.iter_entries_by_dir([file_id]).next()
291
except StopIteration:
292
if file_id in self._non_present_ids:
293
return self._non_present_ids[file_id]
295
trans_id = self._assign_id()
296
self._non_present_ids[file_id] = trans_id
299
return self.trans_id_tree_file_id(file_id)
301
def canonical_path(self, path):
302
"""Get the canonical tree-relative path"""
303
# don't follow final symlinks
304
abs = self._tree.abspath(path)
305
if abs in self._relpaths:
306
return self._relpaths[abs]
307
dirname, basename = os.path.split(abs)
308
if dirname not in self._realpaths:
309
self._realpaths[dirname] = os.path.realpath(dirname)
310
dirname = self._realpaths[dirname]
311
abs = pathjoin(dirname, basename)
312
if dirname in self._relpaths:
313
relpath = pathjoin(self._relpaths[dirname], basename)
314
relpath = relpath.rstrip('/\\')
316
relpath = self._tree.relpath(abs)
317
self._relpaths[abs] = relpath
320
def trans_id_tree_path(self, path):
321
"""Determine (and maybe set) the transaction ID for a tree path."""
322
path = self.canonical_path(path)
323
if path not in self._tree_path_ids:
324
self._tree_path_ids[path] = self._assign_id()
325
self._tree_id_paths[self._tree_path_ids[path]] = path
326
return self._tree_path_ids[path]
328
def get_tree_parent(self, trans_id):
329
"""Determine id of the parent in the tree."""
330
path = self._tree_id_paths[trans_id]
333
return self.trans_id_tree_path(os.path.dirname(path))
335
def create_file(self, contents, trans_id, mode_id=None):
336
"""Schedule creation of a new file.
340
Contents is an iterator of strings, all of which will be written
341
to the target destination.
343
New file takes the permissions of any existing file with that id,
344
unless mode_id is specified.
346
name = self._limbo_name(trans_id)
350
unique_add(self._new_contents, trans_id, 'file')
352
# Clean up the file, it never got registered so
353
# TreeTransform.finalize() won't clean it up.
358
f.writelines(contents)
361
self._set_mode(trans_id, mode_id, S_ISREG)
363
def _set_mode(self, trans_id, mode_id, typefunc):
364
"""Set the mode of new file contents.
365
The mode_id is the existing file to get the mode from (often the same
366
as trans_id). The operation is only performed if there's a mode match
367
according to typefunc.
372
old_path = self._tree_id_paths[mode_id]
376
mode = os.stat(self._tree.abspath(old_path)).st_mode
378
if e.errno in (errno.ENOENT, errno.ENOTDIR):
379
# Either old_path doesn't exist, or the parent of the
380
# target is not a directory (but will be one eventually)
381
# Either way, we know it doesn't exist *right now*
382
# See also bug #248448
387
os.chmod(self._limbo_name(trans_id), mode)
389
def create_hardlink(self, path, trans_id):
390
"""Schedule creation of a hard link"""
391
name = self._limbo_name(trans_id)
395
if e.errno != errno.EPERM:
397
raise errors.HardLinkNotSupported(path)
399
unique_add(self._new_contents, trans_id, 'file')
401
# Clean up the file, it never got registered so
402
# TreeTransform.finalize() won't clean it up.
406
def create_directory(self, trans_id):
407
"""Schedule creation of a new directory.
409
See also new_directory.
411
os.mkdir(self._limbo_name(trans_id))
412
unique_add(self._new_contents, trans_id, 'directory')
414
def create_symlink(self, target, trans_id):
415
"""Schedule creation of a new symbolic link.
417
target is a bytestring.
418
See also new_symlink.
421
os.symlink(target, self._limbo_name(trans_id))
422
unique_add(self._new_contents, trans_id, 'symlink')
425
path = FinalPaths(self).get_path(trans_id)
428
raise UnableCreateSymlink(path=path)
430
def cancel_creation(self, trans_id):
431
"""Cancel the creation of new file contents."""
432
del self._new_contents[trans_id]
433
children = self._limbo_children.get(trans_id)
434
# if this is a limbo directory with children, move them before removing
436
if children is not None:
437
self._rename_in_limbo(children)
438
del self._limbo_children[trans_id]
439
del self._limbo_children_names[trans_id]
440
delete_any(self._limbo_name(trans_id))
442
def delete_contents(self, trans_id):
443
"""Schedule the contents of a path entry for deletion"""
444
self.tree_kind(trans_id)
445
self._removed_contents.add(trans_id)
447
def cancel_deletion(self, trans_id):
448
"""Cancel a scheduled deletion"""
449
self._removed_contents.remove(trans_id)
451
def unversion_file(self, trans_id):
452
"""Schedule a path entry to become unversioned"""
453
self._removed_id.add(trans_id)
455
def delete_versioned(self, trans_id):
456
"""Delete and unversion a versioned file"""
457
self.delete_contents(trans_id)
458
self.unversion_file(trans_id)
460
def set_executability(self, executability, trans_id):
461
"""Schedule setting of the 'execute' bit
462
To unschedule, set to None
464
if executability is None:
465
del self._new_executability[trans_id]
467
unique_add(self._new_executability, trans_id, executability)
469
def set_tree_reference(self, revision_id, trans_id):
470
"""Set the reference associated with a directory"""
471
unique_add(self._new_reference_revision, trans_id, revision_id)
473
def version_file(self, file_id, trans_id):
474
"""Schedule a file to become versioned."""
477
unique_add(self._new_id, trans_id, file_id)
478
unique_add(self._r_new_id, file_id, trans_id)
480
def cancel_versioning(self, trans_id):
481
"""Undo a previous versioning of a file"""
482
file_id = self._new_id[trans_id]
483
del self._new_id[trans_id]
484
del self._r_new_id[file_id]
486
def new_paths(self, filesystem_only=False):
487
"""Determine the paths of all new and changed files.
489
:param filesystem_only: if True, only calculate values for files
490
that require renames or execute bit changes.
494
stale_ids = self._needs_rename.difference(self._new_name)
495
stale_ids.difference_update(self._new_parent)
496
stale_ids.difference_update(self._new_contents)
497
stale_ids.difference_update(self._new_id)
498
needs_rename = self._needs_rename.difference(stale_ids)
499
id_sets = (needs_rename, self._new_executability)
501
id_sets = (self._new_name, self._new_parent, self._new_contents,
502
self._new_id, self._new_executability)
503
for id_set in id_sets:
504
new_ids.update(id_set)
505
return sorted(FinalPaths(self).get_paths(new_ids))
507
def _inventory_altered(self):
508
"""Get the trans_ids and paths of files needing new inv entries."""
510
for id_set in [self._new_name, self._new_parent, self._new_id,
511
self._new_executability]:
512
new_ids.update(id_set)
513
changed_kind = set(self._removed_contents)
514
changed_kind.intersection_update(self._new_contents)
515
changed_kind.difference_update(new_ids)
516
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
518
new_ids.update(changed_kind)
519
return sorted(FinalPaths(self).get_paths(new_ids))
521
def tree_kind(self, trans_id):
522
"""Determine the file kind in the working tree.
524
Raises NoSuchFile if the file does not exist
526
path = self._tree_id_paths.get(trans_id)
528
raise NoSuchFile(None)
530
return file_kind(self._tree.abspath(path))
532
if e.errno != errno.ENOENT:
535
raise NoSuchFile(path)
537
def final_kind(self, trans_id):
538
"""Determine the final file kind, after any changes applied.
540
Raises NoSuchFile if the file does not exist/has no contents.
541
(It is conceivable that a path would be created without the
542
corresponding contents insertion command)
544
if trans_id in self._new_contents:
545
return self._new_contents[trans_id]
546
elif trans_id in self._removed_contents:
547
raise NoSuchFile(None)
549
return self.tree_kind(trans_id)
551
def tree_file_id(self, trans_id):
552
"""Determine the file id associated with the trans_id in the tree"""
554
path = self._tree_id_paths[trans_id]
556
# the file is a new, unversioned file, or invalid trans_id
558
# the file is old; the old id is still valid
559
if self._new_root == trans_id:
560
return self._tree.get_root_id()
561
return self._tree.path2id(path)
563
def final_file_id(self, trans_id):
564
"""Determine the file id after any changes are applied, or None.
566
None indicates that the file will not be versioned after changes are
570
return self._new_id[trans_id]
572
if trans_id in self._removed_id:
574
return self.tree_file_id(trans_id)
576
def inactive_file_id(self, trans_id):
577
"""Return the inactive file_id associated with a transaction id.
578
That is, the one in the tree or in non_present_ids.
579
The file_id may actually be active, too.
581
file_id = self.tree_file_id(trans_id)
582
if file_id is not None:
584
for key, value in self._non_present_ids.iteritems():
585
if value == trans_id:
588
def final_parent(self, trans_id):
589
"""Determine the parent file_id, after any changes are applied.
591
ROOT_PARENT is returned for the tree root.
594
return self._new_parent[trans_id]
596
return self.get_tree_parent(trans_id)
598
def final_name(self, trans_id):
599
"""Determine the final filename, after all changes are applied."""
601
return self._new_name[trans_id]
604
return os.path.basename(self._tree_id_paths[trans_id])
606
raise NoFinalPath(trans_id, self)
609
"""Return a map of parent: children for known parents.
611
Only new paths and parents of tree files with assigned ids are used.
614
items = list(self._new_parent.iteritems())
615
items.extend((t, self.final_parent(t)) for t in
616
self._tree_id_paths.keys())
617
for trans_id, parent_id in items:
618
if parent_id not in by_parent:
619
by_parent[parent_id] = set()
620
by_parent[parent_id].add(trans_id)
623
def path_changed(self, trans_id):
624
"""Return True if a trans_id's path has changed."""
625
return (trans_id in self._new_name) or (trans_id in self._new_parent)
627
def new_contents(self, trans_id):
628
return (trans_id in self._new_contents)
630
def find_conflicts(self):
631
"""Find any violations of inventory or filesystem invariants"""
632
if self._done is True:
633
raise ReusingTransform()
635
# ensure all children of all existent parents are known
636
# all children of non-existent parents are known, by definition.
637
self._add_tree_children()
638
by_parent = self.by_parent()
639
conflicts.extend(self._unversioned_parents(by_parent))
640
conflicts.extend(self._parent_loops())
641
conflicts.extend(self._duplicate_entries(by_parent))
642
conflicts.extend(self._duplicate_ids())
643
conflicts.extend(self._parent_type_conflicts(by_parent))
644
conflicts.extend(self._improper_versioning())
645
conflicts.extend(self._executability_conflicts())
646
conflicts.extend(self._overwrite_conflicts())
649
def _add_tree_children(self):
650
"""Add all the children of all active parents to the known paths.
652
Active parents are those which gain children, and those which are
653
removed. This is a necessary first step in detecting conflicts.
655
parents = self.by_parent().keys()
656
parents.extend([t for t in self._removed_contents if
657
self.tree_kind(t) == 'directory'])
658
for trans_id in self._removed_id:
659
file_id = self.tree_file_id(trans_id)
660
if file_id is not None:
661
if self._tree.inventory[file_id].kind == 'directory':
662
parents.append(trans_id)
663
elif self.tree_kind(trans_id) == 'directory':
664
parents.append(trans_id)
666
for parent_id in parents:
667
# ensure that all children are registered with the transaction
668
list(self.iter_tree_children(parent_id))
670
def iter_tree_children(self, parent_id):
671
"""Iterate through the entry's tree children, if any"""
673
path = self._tree_id_paths[parent_id]
677
children = os.listdir(self._tree.abspath(path))
679
if not (osutils._is_error_enotdir(e)
680
or e.errno in (errno.ENOENT, errno.ESRCH)):
684
for child in children:
685
childpath = joinpath(path, child)
686
if self._tree.is_control_filename(childpath):
688
yield self.trans_id_tree_path(childpath)
690
def has_named_child(self, by_parent, parent_id, name):
692
children = by_parent[parent_id]
695
for child in children:
696
if self.final_name(child) == name:
699
path = self._tree_id_paths[parent_id]
702
childpath = joinpath(path, name)
703
child_id = self._tree_path_ids.get(childpath)
705
return lexists(self._tree.abspath(childpath))
707
if self.final_parent(child_id) != parent_id:
709
if child_id in self._removed_contents:
710
# XXX What about dangling file-ids?
715
def _parent_loops(self):
716
"""No entry should be its own ancestor"""
718
for trans_id in self._new_parent:
721
while parent_id is not ROOT_PARENT:
724
parent_id = self.final_parent(parent_id)
727
if parent_id == trans_id:
728
conflicts.append(('parent loop', trans_id))
729
if parent_id in seen:
733
def _unversioned_parents(self, by_parent):
734
"""If parent directories are versioned, children must be versioned."""
736
for parent_id, children in by_parent.iteritems():
737
if parent_id is ROOT_PARENT:
739
if self.final_file_id(parent_id) is not None:
741
for child_id in children:
742
if self.final_file_id(child_id) is not None:
743
conflicts.append(('unversioned parent', parent_id))
747
def _improper_versioning(self):
748
"""Cannot version a file with no contents, or a bad type.
750
However, existing entries with no contents are okay.
753
for trans_id in self._new_id.iterkeys():
755
kind = self.final_kind(trans_id)
757
conflicts.append(('versioning no contents', trans_id))
759
if not InventoryEntry.versionable_kind(kind):
760
conflicts.append(('versioning bad kind', trans_id, kind))
763
def _executability_conflicts(self):
764
"""Check for bad executability changes.
766
Only versioned files may have their executability set, because
767
1. only versioned entries can have executability under windows
768
2. only files can be executable. (The execute bit on a directory
769
does not indicate searchability)
772
for trans_id in self._new_executability:
773
if self.final_file_id(trans_id) is None:
774
conflicts.append(('unversioned executability', trans_id))
777
non_file = self.final_kind(trans_id) != "file"
781
conflicts.append(('non-file executability', trans_id))
784
def _overwrite_conflicts(self):
785
"""Check for overwrites (not permitted on Win32)"""
787
for trans_id in self._new_contents:
789
self.tree_kind(trans_id)
792
if trans_id not in self._removed_contents:
793
conflicts.append(('overwrite', trans_id,
794
self.final_name(trans_id)))
797
def _duplicate_entries(self, by_parent):
798
"""No directory may have two entries with the same name."""
800
if (self._new_name, self._new_parent) == ({}, {}):
802
for children in by_parent.itervalues():
803
name_ids = [(self.final_name(t), t) for t in children]
804
if not self._case_sensitive_target:
805
name_ids = [(n.lower(), t) for n, t in name_ids]
809
for name, trans_id in name_ids:
811
kind = self.final_kind(trans_id)
814
file_id = self.final_file_id(trans_id)
815
if kind is None and file_id is None:
817
if name == last_name:
818
conflicts.append(('duplicate', last_trans_id, trans_id,
821
last_trans_id = trans_id
824
def _duplicate_ids(self):
825
"""Each inventory id may only be used once"""
827
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
829
all_ids = self._tree.all_file_ids()
830
active_tree_ids = all_ids.difference(removed_tree_ids)
831
for trans_id, file_id in self._new_id.iteritems():
832
if file_id in active_tree_ids:
833
old_trans_id = self.trans_id_tree_file_id(file_id)
834
conflicts.append(('duplicate id', old_trans_id, trans_id))
837
def _parent_type_conflicts(self, by_parent):
838
"""parents must have directory 'contents'."""
840
for parent_id, children in by_parent.iteritems():
841
if parent_id is ROOT_PARENT:
843
if not self._any_contents(children):
845
for child in children:
847
self.final_kind(child)
851
kind = self.final_kind(parent_id)
855
conflicts.append(('missing parent', parent_id))
856
elif kind != "directory":
857
conflicts.append(('non-directory parent', parent_id))
860
def _any_contents(self, trans_ids):
861
"""Return true if any of the trans_ids, will have contents."""
862
for trans_id in trans_ids:
864
kind = self.final_kind(trans_id)
870
def _limbo_name(self, trans_id):
871
"""Generate the limbo name of a file"""
872
limbo_name = self._limbo_files.get(trans_id)
873
if limbo_name is not None:
875
parent = self._new_parent.get(trans_id)
876
# if the parent directory is already in limbo (e.g. when building a
877
# tree), choose a limbo name inside the parent, to reduce further
879
use_direct_path = False
880
if self._new_contents.get(parent) == 'directory':
881
filename = self._new_name.get(trans_id)
882
if filename is not None:
883
if parent not in self._limbo_children:
884
self._limbo_children[parent] = set()
885
self._limbo_children_names[parent] = {}
886
use_direct_path = True
887
# the direct path can only be used if no other file has
888
# already taken this pathname, i.e. if the name is unused, or
889
# if it is already associated with this trans_id.
890
elif self._case_sensitive_target:
891
if (self._limbo_children_names[parent].get(filename)
892
in (trans_id, None)):
893
use_direct_path = True
895
for l_filename, l_trans_id in\
896
self._limbo_children_names[parent].iteritems():
897
if l_trans_id == trans_id:
899
if l_filename.lower() == filename.lower():
902
use_direct_path = True
905
limbo_name = pathjoin(self._limbo_files[parent], filename)
906
self._limbo_children[parent].add(trans_id)
907
self._limbo_children_names[parent][filename] = trans_id
909
limbo_name = pathjoin(self._limbodir, trans_id)
910
self._needs_rename.add(trans_id)
911
self._limbo_files[trans_id] = limbo_name
914
def _set_executability(self, path, trans_id):
915
"""Set the executability of versioned files """
916
if supports_executable():
917
new_executability = self._new_executability[trans_id]
918
abspath = self._tree.abspath(path)
919
current_mode = os.stat(abspath).st_mode
920
if new_executability:
923
to_mode = current_mode | (0100 & ~umask)
924
# Enable x-bit for others only if they can read it.
925
if current_mode & 0004:
926
to_mode |= 0001 & ~umask
927
if current_mode & 0040:
928
to_mode |= 0010 & ~umask
930
to_mode = current_mode & ~0111
931
os.chmod(abspath, to_mode)
933
def _new_entry(self, name, parent_id, file_id):
934
"""Helper function to create a new filesystem entry."""
935
trans_id = self.create_path(name, parent_id)
936
if file_id is not None:
937
self.version_file(file_id, trans_id)
940
def new_file(self, name, parent_id, contents, file_id=None,
942
"""Convenience method to create files.
944
name is the name of the file to create.
945
parent_id is the transaction id of the parent directory of the file.
946
contents is an iterator of bytestrings, which will be used to produce
948
:param file_id: The inventory ID of the file, if it is to be versioned.
949
:param executable: Only valid when a file_id has been supplied.
951
trans_id = self._new_entry(name, parent_id, file_id)
952
# TODO: rather than scheduling a set_executable call,
953
# have create_file create the file with the right mode.
954
self.create_file(contents, trans_id)
955
if executable is not None:
956
self.set_executability(executable, trans_id)
959
def new_directory(self, name, parent_id, file_id=None):
960
"""Convenience method to create directories.
962
name is the name of the directory to create.
963
parent_id is the transaction id of the parent directory of the
965
file_id is the inventory ID of the directory, if it is to be versioned.
967
trans_id = self._new_entry(name, parent_id, file_id)
968
self.create_directory(trans_id)
971
def new_symlink(self, name, parent_id, target, file_id=None):
972
"""Convenience method to create symbolic link.
974
name is the name of the symlink to create.
975
parent_id is the transaction id of the parent directory of the symlink.
976
target is a bytestring of the target of the symlink.
977
file_id is the inventory ID of the file, if it is to be versioned.
979
trans_id = self._new_entry(name, parent_id, file_id)
980
self.create_symlink(target, trans_id)
983
def _affected_ids(self):
984
"""Return the set of transform ids affected by the transform"""
985
trans_ids = set(self._removed_id)
986
trans_ids.update(self._new_id.keys())
987
trans_ids.update(self._removed_contents)
988
trans_ids.update(self._new_contents.keys())
989
trans_ids.update(self._new_executability.keys())
990
trans_ids.update(self._new_name.keys())
991
trans_ids.update(self._new_parent.keys())
994
def _get_file_id_maps(self):
995
"""Return mapping of file_ids to trans_ids in the to and from states"""
996
trans_ids = self._affected_ids()
999
# Build up two dicts: trans_ids associated with file ids in the
1000
# FROM state, vs the TO state.
1001
for trans_id in trans_ids:
1002
from_file_id = self.tree_file_id(trans_id)
1003
if from_file_id is not None:
1004
from_trans_ids[from_file_id] = trans_id
1005
to_file_id = self.final_file_id(trans_id)
1006
if to_file_id is not None:
1007
to_trans_ids[to_file_id] = trans_id
1008
return from_trans_ids, to_trans_ids
1010
def _from_file_data(self, from_trans_id, from_versioned, file_id):
1011
"""Get data about a file in the from (tree) state
1013
Return a (name, parent, kind, executable) tuple
1015
from_path = self._tree_id_paths.get(from_trans_id)
1017
# get data from working tree if versioned
1018
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1019
from_name = from_entry.name
1020
from_parent = from_entry.parent_id
1023
if from_path is None:
1024
# File does not exist in FROM state
1028
# File exists, but is not versioned. Have to use path-
1030
from_name = os.path.basename(from_path)
1031
tree_parent = self.get_tree_parent(from_trans_id)
1032
from_parent = self.tree_file_id(tree_parent)
1033
if from_path is not None:
1034
from_kind, from_executable, from_stats = \
1035
self._tree._comparison_data(from_entry, from_path)
1038
from_executable = False
1039
return from_name, from_parent, from_kind, from_executable
1041
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
1042
"""Get data about a file in the to (target) state
1044
Return a (name, parent, kind, executable) tuple
1046
to_name = self.final_name(to_trans_id)
1048
to_kind = self.final_kind(to_trans_id)
1051
to_parent = self.final_file_id(self.final_parent(to_trans_id))
1052
if to_trans_id in self._new_executability:
1053
to_executable = self._new_executability[to_trans_id]
1054
elif to_trans_id == from_trans_id:
1055
to_executable = from_executable
1057
to_executable = False
1058
return to_name, to_parent, to_kind, to_executable
1060
def iter_changes(self):
1061
"""Produce output in the same format as Tree.iter_changes.
1063
Will produce nonsensical results if invoked while inventory/filesystem
1064
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1066
This reads the Transform, but only reproduces changes involving a
1067
file_id. Files that are not versioned in either of the FROM or TO
1068
states are not reflected.
1070
final_paths = FinalPaths(self)
1071
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1073
# Now iterate through all active file_ids
1074
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1076
from_trans_id = from_trans_ids.get(file_id)
1077
# find file ids, and determine versioning state
1078
if from_trans_id is None:
1079
from_versioned = False
1080
from_trans_id = to_trans_ids[file_id]
1082
from_versioned = True
1083
to_trans_id = to_trans_ids.get(file_id)
1084
if to_trans_id is None:
1085
to_versioned = False
1086
to_trans_id = from_trans_id
1090
from_name, from_parent, from_kind, from_executable = \
1091
self._from_file_data(from_trans_id, from_versioned, file_id)
1093
to_name, to_parent, to_kind, to_executable = \
1094
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1096
if not from_versioned:
1099
from_path = self._tree_id_paths.get(from_trans_id)
1100
if not to_versioned:
1103
to_path = final_paths.get_path(to_trans_id)
1104
if from_kind != to_kind:
1106
elif to_kind in ('file', 'symlink') and (
1107
to_trans_id != from_trans_id or
1108
to_trans_id in self._new_contents):
1110
if (not modified and from_versioned == to_versioned and
1111
from_parent==to_parent and from_name == to_name and
1112
from_executable == to_executable):
1114
results.append((file_id, (from_path, to_path), modified,
1115
(from_versioned, to_versioned),
1116
(from_parent, to_parent),
1117
(from_name, to_name),
1118
(from_kind, to_kind),
1119
(from_executable, to_executable)))
1120
return iter(sorted(results, key=lambda x:x[1]))
1122
def get_preview_tree(self):
1123
"""Return a tree representing the result of the transform.
1125
This tree only supports the subset of Tree functionality required
1126
by show_diff_trees. It must only be compared to tt._tree.
1128
return _PreviewTree(self)
1130
def _text_parent(self, trans_id):
1131
file_id = self.tree_file_id(trans_id)
1133
if file_id is None or self._tree.kind(file_id) != 'file':
1135
except errors.NoSuchFile:
1139
def _get_parents_texts(self, trans_id):
1140
"""Get texts for compression parents of this file."""
1141
file_id = self._text_parent(trans_id)
1144
return (self._tree.get_file_text(file_id),)
1146
def _get_parents_lines(self, trans_id):
1147
"""Get lines for compression parents of this file."""
1148
file_id = self._text_parent(trans_id)
1151
return (self._tree.get_file_lines(file_id),)
1153
def serialize(self, serializer):
1154
"""Serialize this TreeTransform.
1156
:param serializer: A Serialiser like pack.ContainerSerializer.
1158
new_name = dict((k, v.encode('utf-8')) for k, v in
1159
self._new_name.items())
1160
new_executability = dict((k, int(v)) for k, v in
1161
self._new_executability.items())
1162
tree_path_ids = dict((k.encode('utf-8'), v)
1163
for k, v in self._tree_path_ids.items())
1165
'_id_number': self._id_number,
1166
'_new_name': new_name,
1167
'_new_parent': self._new_parent,
1168
'_new_executability': new_executability,
1169
'_new_id': self._new_id,
1170
'_tree_path_ids': tree_path_ids,
1171
'_removed_id': list(self._removed_id),
1172
'_removed_contents': list(self._removed_contents),
1173
'_non_present_ids': self._non_present_ids,
1175
yield serializer.bytes_record(bencode.bencode(attribs),
1177
for trans_id, kind in self._new_contents.items():
1179
cur_file = open(self._limbo_name(trans_id), 'rb')
1181
lines = osutils.chunks_to_lines(cur_file.readlines())
1184
parents = self._get_parents_lines(trans_id)
1185
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1186
content = ''.join(mpdiff.to_patch())
1187
if kind == 'directory':
1189
if kind == 'symlink':
1190
content = os.readlink(self._limbo_name(trans_id))
1191
yield serializer.bytes_record(content, ((trans_id, kind),))
1194
def deserialize(self, records):
1195
"""Deserialize a stored TreeTransform.
1197
:param records: An iterable of (names, content) tuples, as per
1198
pack.ContainerPushParser.
1200
names, content = records.next()
1201
attribs = bencode.bdecode(content)
1202
self._id_number = attribs['_id_number']
1203
self._new_name = dict((k, v.decode('utf-8'))
1204
for k, v in attribs['_new_name'].items())
1205
self._new_parent = attribs['_new_parent']
1206
self._new_executability = dict((k, bool(v)) for k, v in
1207
attribs['_new_executability'].items())
1208
self._new_id = attribs['_new_id']
1209
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1210
self._tree_path_ids = {}
1211
self._tree_id_paths = {}
1212
for bytepath, trans_id in attribs['_tree_path_ids'].items():
1213
path = bytepath.decode('utf-8')
1214
self._tree_path_ids[path] = trans_id
1215
self._tree_id_paths[trans_id] = path
1216
self._removed_id = set(attribs['_removed_id'])
1217
self._removed_contents = set(attribs['_removed_contents'])
1218
self._non_present_ids = attribs['_non_present_ids']
1219
for ((trans_id, kind),), content in records:
1221
mpdiff = multiparent.MultiParent.from_patch(content)
1222
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1223
self.create_file(lines, trans_id)
1224
if kind == 'directory':
1225
self.create_directory(trans_id)
1226
if kind == 'symlink':
1227
self.create_symlink(content.decode('utf-8'), trans_id)
1230
class TreeTransform(TreeTransformBase):
1231
"""Represent a tree transformation.
1233
This object is designed to support incremental generation of the transform,
1236
However, it gives optimum performance when parent directories are created
1237
before their contents. The transform is then able to put child files
1238
directly in their parent directory, avoiding later renames.
1240
It is easy to produce malformed transforms, but they are generally
1241
harmless. Attempting to apply a malformed transform will cause an
1242
exception to be raised before any modifications are made to the tree.
1244
Many kinds of malformed transforms can be corrected with the
1245
resolve_conflicts function. The remaining ones indicate programming error,
1246
such as trying to create a file with no path.
1248
Two sets of file creation methods are supplied. Convenience methods are:
1253
These are composed of the low-level methods:
1255
* create_file or create_directory or create_symlink
1259
Transform/Transaction ids
1260
-------------------------
1261
trans_ids are temporary ids assigned to all files involved in a transform.
1262
It's possible, even common, that not all files in the Tree have trans_ids.
1264
trans_ids are used because filenames and file_ids are not good enough
1265
identifiers; filenames change, and not all files have file_ids. File-ids
1266
are also associated with trans-ids, so that moving a file moves its
1269
trans_ids are only valid for the TreeTransform that generated them.
1273
Limbo is a temporary directory use to hold new versions of files.
1274
Files are added to limbo by create_file, create_directory, create_symlink,
1275
and their convenience variants (new_*). Files may be removed from limbo
1276
using cancel_creation. Files are renamed from limbo into their final
1277
location as part of TreeTransform.apply
1279
Limbo must be cleaned up, by either calling TreeTransform.apply or
1280
calling TreeTransform.finalize.
1282
Files are placed into limbo inside their parent directories, where
1283
possible. This reduces subsequent renames, and makes operations involving
1284
lots of files faster. This optimization is only possible if the parent
1285
directory is created *before* creating any of its children, so avoid
1286
creating children before parents, where possible.
1290
This temporary directory is used by _FileMover for storing files that are
1291
about to be deleted. In case of rollback, the files will be restored.
1292
FileMover does not delete files until it is sure that a rollback will not
1295
def __init__(self, tree, pb=DummyProgress()):
1296
"""Note: a tree_write lock is taken on the tree.
1298
Use TreeTransform.finalize() to release the lock (can be omitted if
1299
TreeTransform.apply() called).
1301
tree.lock_tree_write()
1304
limbodir = urlutils.local_path_from_url(
1305
tree._transport.abspath('limbo'))
1309
if e.errno == errno.EEXIST:
1310
raise ExistingLimbo(limbodir)
1311
deletiondir = urlutils.local_path_from_url(
1312
tree._transport.abspath('pending-deletion'))
1314
os.mkdir(deletiondir)
1316
if e.errno == errno.EEXIST:
1317
raise errors.ExistingPendingDeletion(deletiondir)
1322
TreeTransformBase.__init__(self, tree, limbodir, pb,
1323
tree.case_sensitive)
1324
self._deletiondir = deletiondir
1326
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1327
"""Apply all changes to the inventory and filesystem.
1329
If filesystem or inventory conflicts are present, MalformedTransform
1332
If apply succeeds, finalize is not necessary.
1334
:param no_conflicts: if True, the caller guarantees there are no
1335
conflicts, so no check is made.
1336
:param precomputed_delta: An inventory delta to use instead of
1338
:param _mover: Supply an alternate FileMover, for testing
1340
if not no_conflicts:
1341
conflicts = self.find_conflicts()
1342
if len(conflicts) != 0:
1343
raise MalformedTransform(conflicts=conflicts)
1344
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1346
if precomputed_delta is None:
1347
child_pb.update('Apply phase', 0, 2)
1348
inventory_delta = self._generate_inventory_delta()
1351
inventory_delta = precomputed_delta
1354
mover = _FileMover()
1358
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1359
self._apply_removals(mover)
1360
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1361
modified_paths = self._apply_insertions(mover)
1366
mover.apply_deletions()
1369
self._tree.apply_inventory_delta(inventory_delta)
1372
return _TransformResults(modified_paths, self.rename_count)
1374
def _generate_inventory_delta(self):
1375
"""Generate an inventory delta for the current transform."""
1376
inventory_delta = []
1377
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1378
new_paths = self._inventory_altered()
1379
total_entries = len(new_paths) + len(self._removed_id)
1381
for num, trans_id in enumerate(self._removed_id):
1383
child_pb.update('removing file', num, total_entries)
1384
if trans_id == self._new_root:
1385
file_id = self._tree.get_root_id()
1387
file_id = self.tree_file_id(trans_id)
1388
# File-id isn't really being deleted, just moved
1389
if file_id in self._r_new_id:
1391
path = self._tree_id_paths[trans_id]
1392
inventory_delta.append((path, None, file_id, None))
1393
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1395
entries = self._tree.iter_entries_by_dir(
1396
new_path_file_ids.values())
1397
old_paths = dict((e.file_id, p) for p, e in entries)
1399
for num, (path, trans_id) in enumerate(new_paths):
1401
child_pb.update('adding file',
1402
num + len(self._removed_id), total_entries)
1403
file_id = new_path_file_ids[trans_id]
1408
kind = self.final_kind(trans_id)
1410
kind = self._tree.stored_kind(file_id)
1411
parent_trans_id = self.final_parent(trans_id)
1412
parent_file_id = new_path_file_ids.get(parent_trans_id)
1413
if parent_file_id is None:
1414
parent_file_id = self.final_file_id(parent_trans_id)
1415
if trans_id in self._new_reference_revision:
1416
new_entry = inventory.TreeReference(
1418
self._new_name[trans_id],
1419
self.final_file_id(self._new_parent[trans_id]),
1420
None, self._new_reference_revision[trans_id])
1422
new_entry = inventory.make_entry(kind,
1423
self.final_name(trans_id),
1424
parent_file_id, file_id)
1425
old_path = old_paths.get(new_entry.file_id)
1426
new_executability = self._new_executability.get(trans_id)
1427
if new_executability is not None:
1428
new_entry.executable = new_executability
1429
inventory_delta.append(
1430
(old_path, path, new_entry.file_id, new_entry))
1433
return inventory_delta
1435
def _apply_removals(self, mover):
1436
"""Perform tree operations that remove directory/inventory names.
1438
That is, delete files that are to be deleted, and put any files that
1439
need renaming into limbo. This must be done in strict child-to-parent
1442
If inventory_delta is None, no inventory delta generation is performed.
1444
tree_paths = list(self._tree_path_ids.iteritems())
1445
tree_paths.sort(reverse=True)
1446
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1448
for num, data in enumerate(tree_paths):
1449
path, trans_id = data
1450
child_pb.update('removing file', num, len(tree_paths))
1451
full_path = self._tree.abspath(path)
1452
if trans_id in self._removed_contents:
1453
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1455
elif trans_id in self._new_name or trans_id in \
1458
mover.rename(full_path, self._limbo_name(trans_id))
1460
if e.errno != errno.ENOENT:
1463
self.rename_count += 1
1467
def _apply_insertions(self, mover):
1468
"""Perform tree operations that insert directory/inventory names.
1470
That is, create any files that need to be created, and restore from
1471
limbo any files that needed renaming. This must be done in strict
1472
parent-to-child order.
1474
If inventory_delta is None, no inventory delta is calculated, and
1475
no list of modified paths is returned.
1477
new_paths = self.new_paths(filesystem_only=True)
1479
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1481
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1483
for num, (path, trans_id) in enumerate(new_paths):
1485
child_pb.update('adding file', num, len(new_paths))
1486
full_path = self._tree.abspath(path)
1487
if trans_id in self._needs_rename:
1489
mover.rename(self._limbo_name(trans_id), full_path)
1491
# We may be renaming a dangling inventory id
1492
if e.errno != errno.ENOENT:
1495
self.rename_count += 1
1496
if (trans_id in self._new_contents or
1497
self.path_changed(trans_id)):
1498
if trans_id in self._new_contents:
1499
modified_paths.append(full_path)
1500
if trans_id in self._new_executability:
1501
self._set_executability(path, trans_id)
1504
self._new_contents.clear()
1505
return modified_paths
1508
class TransformPreview(TreeTransformBase):
1509
"""A TreeTransform for generating preview trees.
1511
Unlike TreeTransform, this version works when the input tree is a
1512
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1513
unversioned files in the input tree.
1516
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1518
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1519
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1521
def canonical_path(self, path):
1524
def tree_kind(self, trans_id):
1525
path = self._tree_id_paths.get(trans_id)
1527
raise NoSuchFile(None)
1528
file_id = self._tree.path2id(path)
1529
return self._tree.kind(file_id)
1531
def _set_mode(self, trans_id, mode_id, typefunc):
1532
"""Set the mode of new file contents.
1533
The mode_id is the existing file to get the mode from (often the same
1534
as trans_id). The operation is only performed if there's a mode match
1535
according to typefunc.
1537
# is it ok to ignore this? probably
1540
def iter_tree_children(self, parent_id):
1541
"""Iterate through the entry's tree children, if any"""
1543
path = self._tree_id_paths[parent_id]
1546
file_id = self.tree_file_id(parent_id)
1549
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1550
children = getattr(entry, 'children', {})
1551
for child in children:
1552
childpath = joinpath(path, child)
1553
yield self.trans_id_tree_path(childpath)
1556
class _PreviewTree(tree.Tree):
1557
"""Partial implementation of Tree to support show_diff_trees"""
1559
def __init__(self, transform):
1560
self._transform = transform
1561
self._final_paths = FinalPaths(transform)
1562
self.__by_parent = None
1563
self._parent_ids = []
1564
self._all_children_cache = {}
1565
self._path2trans_id_cache = {}
1566
self._final_name_cache = {}
1568
def _changes(self, file_id):
1569
for changes in self._transform.iter_changes():
1570
if changes[0] == file_id:
1573
def _content_change(self, file_id):
1574
"""Return True if the content of this file changed"""
1575
changes = self._changes(file_id)
1576
# changes[2] is true if the file content changed. See
1577
# InterTree.iter_changes.
1578
return (changes is not None and changes[2])
1580
def _get_repository(self):
1581
repo = getattr(self._transform._tree, '_repository', None)
1583
repo = self._transform._tree.branch.repository
1586
def _iter_parent_trees(self):
1587
for revision_id in self.get_parent_ids():
1589
yield self.revision_tree(revision_id)
1590
except errors.NoSuchRevisionInTree:
1591
yield self._get_repository().revision_tree(revision_id)
1593
def _get_file_revision(self, file_id, vf, tree_revision):
1594
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1595
self._iter_parent_trees()]
1596
vf.add_lines((file_id, tree_revision), parent_keys,
1597
self.get_file(file_id).readlines())
1598
repo = self._get_repository()
1599
base_vf = repo.texts
1600
if base_vf not in vf.fallback_versionedfiles:
1601
vf.fallback_versionedfiles.append(base_vf)
1602
return tree_revision
1604
def _stat_limbo_file(self, file_id):
1605
trans_id = self._transform.trans_id_file_id(file_id)
1606
name = self._transform._limbo_name(trans_id)
1607
return os.lstat(name)
1610
def _by_parent(self):
1611
if self.__by_parent is None:
1612
self.__by_parent = self._transform.by_parent()
1613
return self.__by_parent
1615
def _comparison_data(self, entry, path):
1616
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1617
if kind == 'missing':
1621
file_id = self._transform.final_file_id(self._path2trans_id(path))
1622
executable = self.is_executable(file_id, path)
1623
return kind, executable, None
1625
def lock_read(self):
1626
# Perhaps in theory, this should lock the TreeTransform?
1633
def inventory(self):
1634
"""This Tree does not use inventory as its backing data."""
1635
raise NotImplementedError(_PreviewTree.inventory)
1637
def get_root_id(self):
1638
return self._transform.final_file_id(self._transform.root)
1640
def all_file_ids(self):
1641
tree_ids = set(self._transform._tree.all_file_ids())
1642
tree_ids.difference_update(self._transform.tree_file_id(t)
1643
for t in self._transform._removed_id)
1644
tree_ids.update(self._transform._new_id.values())
1648
return iter(self.all_file_ids())
1650
def has_id(self, file_id):
1651
if file_id in self._transform._r_new_id:
1653
elif file_id in set([self._transform.tree_file_id(trans_id) for
1654
trans_id in self._transform._removed_id]):
1657
return self._transform._tree.has_id(file_id)
1659
def _path2trans_id(self, path):
1660
# We must not use None here, because that is a valid value to store.
1661
trans_id = self._path2trans_id_cache.get(path, object)
1662
if trans_id is not object:
1664
segments = splitpath(path)
1665
cur_parent = self._transform.root
1666
for cur_segment in segments:
1667
for child in self._all_children(cur_parent):
1668
final_name = self._final_name_cache.get(child)
1669
if final_name is None:
1670
final_name = self._transform.final_name(child)
1671
self._final_name_cache[child] = final_name
1672
if final_name == cur_segment:
1676
self._path2trans_id_cache[path] = None
1678
self._path2trans_id_cache[path] = cur_parent
1681
def path2id(self, path):
1682
return self._transform.final_file_id(self._path2trans_id(path))
1684
def id2path(self, file_id):
1685
trans_id = self._transform.trans_id_file_id(file_id)
1687
return self._final_paths._determine_path(trans_id)
1689
raise errors.NoSuchId(self, file_id)
1691
def _all_children(self, trans_id):
1692
children = self._all_children_cache.get(trans_id)
1693
if children is not None:
1695
children = set(self._transform.iter_tree_children(trans_id))
1696
# children in the _new_parent set are provided by _by_parent.
1697
children.difference_update(self._transform._new_parent.keys())
1698
children.update(self._by_parent.get(trans_id, []))
1699
self._all_children_cache[trans_id] = children
1702
def iter_children(self, file_id):
1703
trans_id = self._transform.trans_id_file_id(file_id)
1704
for child_trans_id in self._all_children(trans_id):
1705
yield self._transform.final_file_id(child_trans_id)
1708
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1709
in self._transform._tree.extras())
1710
possible_extras.update(self._transform._new_contents)
1711
possible_extras.update(self._transform._removed_id)
1712
for trans_id in possible_extras:
1713
if self._transform.final_file_id(trans_id) is None:
1714
yield self._final_paths._determine_path(trans_id)
1716
def _make_inv_entries(self, ordered_entries, specific_file_ids):
1717
for trans_id, parent_file_id in ordered_entries:
1718
file_id = self._transform.final_file_id(trans_id)
1721
if (specific_file_ids is not None
1722
and file_id not in specific_file_ids):
1725
kind = self._transform.final_kind(trans_id)
1727
kind = self._transform._tree.stored_kind(file_id)
1728
new_entry = inventory.make_entry(
1730
self._transform.final_name(trans_id),
1731
parent_file_id, file_id)
1732
yield new_entry, trans_id
1734
def _list_files_by_dir(self):
1735
todo = [ROOT_PARENT]
1737
while len(todo) > 0:
1739
parent_file_id = self._transform.final_file_id(parent)
1740
children = list(self._all_children(parent))
1741
paths = dict(zip(children, self._final_paths.get_paths(children)))
1742
children.sort(key=paths.get)
1743
todo.extend(reversed(children))
1744
for trans_id in children:
1745
ordered_ids.append((trans_id, parent_file_id))
1748
def iter_entries_by_dir(self, specific_file_ids=None):
1749
# This may not be a maximally efficient implementation, but it is
1750
# reasonably straightforward. An implementation that grafts the
1751
# TreeTransform changes onto the tree's iter_entries_by_dir results
1752
# might be more efficient, but requires tricky inferences about stack
1754
ordered_ids = self._list_files_by_dir()
1755
for entry, trans_id in self._make_inv_entries(ordered_ids,
1757
yield unicode(self._final_paths.get_path(trans_id)), entry
1759
def list_files(self, include_root=False):
1760
"""See Tree.list_files."""
1761
# XXX This should behave like WorkingTree.list_files, but is really
1762
# more like RevisionTree.list_files.
1763
for path, entry in self.iter_entries_by_dir():
1764
if entry.name == '' and not include_root:
1766
yield path, 'V', entry.kind, entry.file_id, entry
1768
def kind(self, file_id):
1769
trans_id = self._transform.trans_id_file_id(file_id)
1770
return self._transform.final_kind(trans_id)
1772
def stored_kind(self, file_id):
1773
trans_id = self._transform.trans_id_file_id(file_id)
1775
return self._transform._new_contents[trans_id]
1777
return self._transform._tree.stored_kind(file_id)
1779
def get_file_mtime(self, file_id, path=None):
1780
"""See Tree.get_file_mtime"""
1781
if not self._content_change(file_id):
1782
return self._transform._tree.get_file_mtime(file_id, path)
1783
return self._stat_limbo_file(file_id).st_mtime
1785
def _file_size(self, entry, stat_value):
1786
return self.get_file_size(entry.file_id)
1788
def get_file_size(self, file_id):
1789
"""See Tree.get_file_size"""
1790
if self.kind(file_id) == 'file':
1791
return self._transform._tree.get_file_size(file_id)
1795
def get_file_sha1(self, file_id, path=None, stat_value=None):
1796
trans_id = self._transform.trans_id_file_id(file_id)
1797
kind = self._transform._new_contents.get(trans_id)
1799
return self._transform._tree.get_file_sha1(file_id)
1801
fileobj = self.get_file(file_id)
1803
return sha_file(fileobj)
1807
def is_executable(self, file_id, path=None):
1810
trans_id = self._transform.trans_id_file_id(file_id)
1812
return self._transform._new_executability[trans_id]
1815
return self._transform._tree.is_executable(file_id, path)
1817
if e.errno == errno.ENOENT:
1820
except errors.NoSuchId:
1823
def path_content_summary(self, path):
1824
trans_id = self._path2trans_id(path)
1825
tt = self._transform
1826
tree_path = tt._tree_id_paths.get(trans_id)
1827
kind = tt._new_contents.get(trans_id)
1829
if tree_path is None or trans_id in tt._removed_contents:
1830
return 'missing', None, None, None
1831
summary = tt._tree.path_content_summary(tree_path)
1832
kind, size, executable, link_or_sha1 = summary
1835
limbo_name = tt._limbo_name(trans_id)
1836
if trans_id in tt._new_reference_revision:
1837
kind = 'tree-reference'
1839
statval = os.lstat(limbo_name)
1840
size = statval.st_size
1841
if not supports_executable():
1844
executable = statval.st_mode & S_IEXEC
1848
if kind == 'symlink':
1849
link_or_sha1 = os.readlink(limbo_name).decode(osutils._fs_enc)
1850
if supports_executable():
1851
executable = tt._new_executability.get(trans_id, executable)
1852
return kind, size, executable, link_or_sha1
1854
def iter_changes(self, from_tree, include_unchanged=False,
1855
specific_files=None, pb=None, extra_trees=None,
1856
require_versioned=True, want_unversioned=False):
1857
"""See InterTree.iter_changes.
1859
This has a fast path that is only used when the from_tree matches
1860
the transform tree, and no fancy options are supplied.
1862
if (from_tree is not self._transform._tree or include_unchanged or
1863
specific_files or want_unversioned):
1864
return tree.InterTree(from_tree, self).iter_changes(
1865
include_unchanged=include_unchanged,
1866
specific_files=specific_files,
1868
extra_trees=extra_trees,
1869
require_versioned=require_versioned,
1870
want_unversioned=want_unversioned)
1871
if want_unversioned:
1872
raise ValueError('want_unversioned is not supported')
1873
return self._transform.iter_changes()
1875
def get_file(self, file_id, path=None):
1876
"""See Tree.get_file"""
1877
if not self._content_change(file_id):
1878
return self._transform._tree.get_file(file_id, path)
1879
trans_id = self._transform.trans_id_file_id(file_id)
1880
name = self._transform._limbo_name(trans_id)
1881
return open(name, 'rb')
1883
def get_file_with_stat(self, file_id, path):
1884
return self.get_file(file_id, path), None
1886
def annotate_iter(self, file_id,
1887
default_revision=_mod_revision.CURRENT_REVISION):
1888
changes = self._changes(file_id)
1892
changed_content, versioned, kind = (changes[2], changes[3],
1896
get_old = (kind[0] == 'file' and versioned[0])
1898
old_annotation = self._transform._tree.annotate_iter(file_id,
1899
default_revision=default_revision)
1903
return old_annotation
1904
if not changed_content:
1905
return old_annotation
1906
return annotate.reannotate([old_annotation],
1907
self.get_file(file_id).readlines(),
1910
def get_symlink_target(self, file_id):
1911
"""See Tree.get_symlink_target"""
1912
if not self._content_change(file_id):
1913
return self._transform._tree.get_symlink_target(file_id)
1914
trans_id = self._transform.trans_id_file_id(file_id)
1915
name = self._transform._limbo_name(trans_id)
1916
return osutils.readlink(name)
1918
def walkdirs(self, prefix=''):
1919
pending = [self._transform.root]
1920
while len(pending) > 0:
1921
parent_id = pending.pop()
1924
prefix = prefix.rstrip('/')
1925
parent_path = self._final_paths.get_path(parent_id)
1926
parent_file_id = self._transform.final_file_id(parent_id)
1927
for child_id in self._all_children(parent_id):
1928
path_from_root = self._final_paths.get_path(child_id)
1929
basename = self._transform.final_name(child_id)
1930
file_id = self._transform.final_file_id(child_id)
1932
kind = self._transform.final_kind(child_id)
1933
versioned_kind = kind
1936
versioned_kind = self._transform._tree.stored_kind(file_id)
1937
if versioned_kind == 'directory':
1938
subdirs.append(child_id)
1939
children.append((path_from_root, basename, kind, None,
1940
file_id, versioned_kind))
1942
if parent_path.startswith(prefix):
1943
yield (parent_path, parent_file_id), children
1944
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
1947
def get_parent_ids(self):
1948
return self._parent_ids
1950
def set_parent_ids(self, parent_ids):
1951
self._parent_ids = parent_ids
1953
def get_revision_tree(self, revision_id):
1954
return self._transform._tree.get_revision_tree(revision_id)
1957
def joinpath(parent, child):
1958
"""Join tree-relative paths, handling the tree root specially"""
1959
if parent is None or parent == "":
1962
return pathjoin(parent, child)
1965
class FinalPaths(object):
1966
"""Make path calculation cheap by memoizing paths.
1968
The underlying tree must not be manipulated between calls, or else
1969
the results will likely be incorrect.
1971
def __init__(self, transform):
1972
object.__init__(self)
1973
self._known_paths = {}
1974
self.transform = transform
1976
def _determine_path(self, trans_id):
1977
if trans_id == self.transform.root:
1979
name = self.transform.final_name(trans_id)
1980
parent_id = self.transform.final_parent(trans_id)
1981
if parent_id == self.transform.root:
1984
return pathjoin(self.get_path(parent_id), name)
1986
def get_path(self, trans_id):
1987
"""Find the final path associated with a trans_id"""
1988
if trans_id not in self._known_paths:
1989
self._known_paths[trans_id] = self._determine_path(trans_id)
1990
return self._known_paths[trans_id]
1992
def get_paths(self, trans_ids):
1993
return [(self.get_path(t), t) for t in trans_ids]
1997
def topology_sorted_ids(tree):
1998
"""Determine the topological order of the ids in a tree"""
1999
file_ids = list(tree)
2000
file_ids.sort(key=tree.id2path)
2004
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2005
delta_from_tree=False):
2006
"""Create working tree for a branch, using a TreeTransform.
2008
This function should be used on empty trees, having a tree root at most.
2009
(see merge and revert functionality for working with existing trees)
2011
Existing files are handled like so:
2013
- Existing bzrdirs take precedence over creating new items. They are
2014
created as '%s.diverted' % name.
2015
- Otherwise, if the content on disk matches the content we are building,
2016
it is silently replaced.
2017
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2019
:param tree: The tree to convert wt into a copy of
2020
:param wt: The working tree that files will be placed into
2021
:param accelerator_tree: A tree which can be used for retrieving file
2022
contents more quickly than tree itself, i.e. a workingtree. tree
2023
will be used for cases where accelerator_tree's content is different.
2024
:param hardlink: If true, hard-link files to accelerator_tree, where
2025
possible. accelerator_tree must implement abspath, i.e. be a
2027
:param delta_from_tree: If true, build_tree may use the input Tree to
2028
generate the inventory delta.
2030
wt.lock_tree_write()
2034
if accelerator_tree is not None:
2035
accelerator_tree.lock_read()
2037
return _build_tree(tree, wt, accelerator_tree, hardlink,
2040
if accelerator_tree is not None:
2041
accelerator_tree.unlock()
2048
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2049
"""See build_tree."""
2050
for num, _unused in enumerate(wt.all_file_ids()):
2051
if num > 0: # more than just a root
2052
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2053
existing_files = set()
2054
for dir, files in wt.walkdirs():
2055
existing_files.update(f[0] for f in files)
2057
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2058
pp = ProgressPhase("Build phase", 2, top_pb)
2059
if tree.inventory.root is not None:
2060
# This is kind of a hack: we should be altering the root
2061
# as part of the regular tree shape diff logic.
2062
# The conditional test here is to avoid doing an
2063
# expensive operation (flush) every time the root id
2064
# is set within the tree, nor setting the root and thus
2065
# marking the tree as dirty, because we use two different
2066
# idioms here: tree interfaces and inventory interfaces.
2067
if wt.get_root_id() != tree.get_root_id():
2068
wt.set_root_id(tree.get_root_id())
2070
tt = TreeTransform(wt)
2074
file_trans_id[wt.get_root_id()] = \
2075
tt.trans_id_tree_file_id(wt.get_root_id())
2076
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2078
deferred_contents = []
2080
total = len(tree.inventory)
2082
precomputed_delta = []
2084
precomputed_delta = None
2085
for num, (tree_path, entry) in \
2086
enumerate(tree.inventory.iter_entries_by_dir()):
2087
pb.update("Building tree", num - len(deferred_contents), total)
2088
if entry.parent_id is None:
2091
file_id = entry.file_id
2093
precomputed_delta.append((None, tree_path, file_id, entry))
2094
if tree_path in existing_files:
2095
target_path = wt.abspath(tree_path)
2096
kind = file_kind(target_path)
2097
if kind == "directory":
2099
bzrdir.BzrDir.open(target_path)
2100
except errors.NotBranchError:
2104
if (file_id not in divert and
2105
_content_match(tree, entry, file_id, kind,
2107
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2108
if kind == 'directory':
2110
parent_id = file_trans_id[entry.parent_id]
2111
if entry.kind == 'file':
2112
# We *almost* replicate new_by_entry, so that we can defer
2113
# getting the file text, and get them all at once.
2114
trans_id = tt.create_path(entry.name, parent_id)
2115
file_trans_id[file_id] = trans_id
2116
tt.version_file(file_id, trans_id)
2117
executable = tree.is_executable(file_id, tree_path)
2119
tt.set_executability(executable, trans_id)
2120
trans_data = (trans_id, tree_path)
2121
deferred_contents.append((file_id, trans_data))
2123
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2126
new_trans_id = file_trans_id[file_id]
2127
old_parent = tt.trans_id_tree_path(tree_path)
2128
_reparent_children(tt, old_parent, new_trans_id)
2129
offset = num + 1 - len(deferred_contents)
2130
_create_files(tt, tree, deferred_contents, pb, offset,
2131
accelerator_tree, hardlink)
2135
divert_trans = set(file_trans_id[f] for f in divert)
2136
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2137
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2138
if len(raw_conflicts) > 0:
2139
precomputed_delta = None
2140
conflicts = cook_conflicts(raw_conflicts, tt)
2141
for conflict in conflicts:
2144
wt.add_conflicts(conflicts)
2145
except errors.UnsupportedOperation:
2147
result = tt.apply(no_conflicts=True,
2148
precomputed_delta=precomputed_delta)
2155
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2157
total = len(desired_files) + offset
2159
if accelerator_tree is None:
2160
new_desired_files = desired_files
2162
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2163
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2164
in iter if not (c or e[0] != e[1]))
2165
new_desired_files = []
2167
for file_id, (trans_id, tree_path) in desired_files:
2168
accelerator_path = unchanged.get(file_id)
2169
if accelerator_path is None:
2170
new_desired_files.append((file_id, (trans_id, tree_path)))
2172
pb.update('Adding file contents', count + offset, total)
2174
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2177
contents = accelerator_tree.get_file(file_id, accelerator_path)
2178
if wt.supports_content_filtering():
2179
filters = wt._content_filter_stack(tree_path)
2180
contents = filtered_output_bytes(contents, filters,
2181
ContentFilterContext(tree_path, tree))
2183
tt.create_file(contents, trans_id)
2187
except AttributeError:
2188
# after filtering, contents may no longer be file-like
2192
for count, ((trans_id, tree_path), contents) in enumerate(
2193
tree.iter_files_bytes(new_desired_files)):
2194
if wt.supports_content_filtering():
2195
filters = wt._content_filter_stack(tree_path)
2196
contents = filtered_output_bytes(contents, filters,
2197
ContentFilterContext(tree_path, tree))
2198
tt.create_file(contents, trans_id)
2199
pb.update('Adding file contents', count + offset, total)
2202
def _reparent_children(tt, old_parent, new_parent):
2203
for child in tt.iter_tree_children(old_parent):
2204
tt.adjust_path(tt.final_name(child), new_parent, child)
2206
def _reparent_transform_children(tt, old_parent, new_parent):
2207
by_parent = tt.by_parent()
2208
for child in by_parent[old_parent]:
2209
tt.adjust_path(tt.final_name(child), new_parent, child)
2210
return by_parent[old_parent]
2212
def _content_match(tree, entry, file_id, kind, target_path):
2213
if entry.kind != kind:
2215
if entry.kind == "directory":
2217
if entry.kind == "file":
2218
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2220
elif entry.kind == "symlink":
2221
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2226
def resolve_checkout(tt, conflicts, divert):
2227
new_conflicts = set()
2228
for c_type, conflict in ((c[0], c) for c in conflicts):
2229
# Anything but a 'duplicate' would indicate programmer error
2230
if c_type != 'duplicate':
2231
raise AssertionError(c_type)
2232
# Now figure out which is new and which is old
2233
if tt.new_contents(conflict[1]):
2234
new_file = conflict[1]
2235
old_file = conflict[2]
2237
new_file = conflict[2]
2238
old_file = conflict[1]
2240
# We should only get here if the conflict wasn't completely
2242
final_parent = tt.final_parent(old_file)
2243
if new_file in divert:
2244
new_name = tt.final_name(old_file)+'.diverted'
2245
tt.adjust_path(new_name, final_parent, new_file)
2246
new_conflicts.add((c_type, 'Diverted to',
2247
new_file, old_file))
2249
new_name = tt.final_name(old_file)+'.moved'
2250
tt.adjust_path(new_name, final_parent, old_file)
2251
new_conflicts.add((c_type, 'Moved existing file to',
2252
old_file, new_file))
2253
return new_conflicts
2256
def new_by_entry(tt, entry, parent_id, tree):
2257
"""Create a new file according to its inventory entry"""
2261
contents = tree.get_file(entry.file_id).readlines()
2262
executable = tree.is_executable(entry.file_id)
2263
return tt.new_file(name, parent_id, contents, entry.file_id,
2265
elif kind in ('directory', 'tree-reference'):
2266
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2267
if kind == 'tree-reference':
2268
tt.set_tree_reference(entry.reference_revision, trans_id)
2270
elif kind == 'symlink':
2271
target = tree.get_symlink_target(entry.file_id)
2272
return tt.new_symlink(name, parent_id, target, entry.file_id)
2274
raise errors.BadFileKindError(name, kind)
2277
@deprecated_function(deprecated_in((1, 9, 0)))
2278
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2279
"""Create new file contents according to an inventory entry.
2281
DEPRECATED. Use create_from_tree instead.
2283
if entry.kind == "file":
2285
lines = tree.get_file(entry.file_id).readlines()
2286
tt.create_file(lines, trans_id, mode_id=mode_id)
2287
elif entry.kind == "symlink":
2288
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2289
elif entry.kind == "directory":
2290
tt.create_directory(trans_id)
2293
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2294
"""Create new file contents according to tree contents."""
2295
kind = tree.kind(file_id)
2296
if kind == 'directory':
2297
tt.create_directory(trans_id)
2298
elif kind == "file":
2300
tree_file = tree.get_file(file_id)
2302
bytes = tree_file.readlines()
2305
tt.create_file(bytes, trans_id)
2306
elif kind == "symlink":
2307
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2309
raise AssertionError('Unknown kind %r' % kind)
2312
def create_entry_executability(tt, entry, trans_id):
2313
"""Set the executability of a trans_id according to an inventory entry"""
2314
if entry.kind == "file":
2315
tt.set_executability(entry.executable, trans_id)
2318
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2319
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2322
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2323
"""Produce a backup-style name that appears to be available"""
2327
yield "%s.~%d~" % (name, counter)
2329
for new_name in name_gen():
2330
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2334
def _entry_changes(file_id, entry, working_tree):
2335
"""Determine in which ways the inventory entry has changed.
2337
Returns booleans: has_contents, content_mod, meta_mod
2338
has_contents means there are currently contents, but they differ
2339
contents_mod means contents need to be modified
2340
meta_mod means the metadata needs to be modified
2342
cur_entry = working_tree.inventory[file_id]
2344
working_kind = working_tree.kind(file_id)
2347
has_contents = False
2350
if has_contents is True:
2351
if entry.kind != working_kind:
2352
contents_mod, meta_mod = True, False
2354
cur_entry._read_tree_state(working_tree.id2path(file_id),
2356
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2357
cur_entry._forget_tree_state()
2358
return has_contents, contents_mod, meta_mod
2361
def revert(working_tree, target_tree, filenames, backups=False,
2362
pb=DummyProgress(), change_reporter=None):
2363
"""Revert a working tree's contents to those of a target tree."""
2364
target_tree.lock_read()
2365
tt = TreeTransform(working_tree, pb)
2367
pp = ProgressPhase("Revert phase", 3, pb)
2368
conflicts, merge_modified = _prepare_revert_transform(
2369
working_tree, target_tree, tt, filenames, backups, pp)
2371
change_reporter = delta._ChangeReporter(
2372
unversioned_filter=working_tree.is_ignored)
2373
delta.report_changes(tt.iter_changes(), change_reporter)
2374
for conflict in conflicts:
2378
working_tree.set_merge_modified(merge_modified)
2380
target_tree.unlock()
2386
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2387
backups, pp, basis_tree=None,
2388
merge_modified=None):
2390
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2392
if merge_modified is None:
2393
merge_modified = working_tree.merge_modified()
2394
merge_modified = _alter_files(working_tree, target_tree, tt,
2395
child_pb, filenames, backups,
2396
merge_modified, basis_tree)
2400
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2402
raw_conflicts = resolve_conflicts(tt, child_pb,
2403
lambda t, c: conflict_pass(t, c, target_tree))
2406
conflicts = cook_conflicts(raw_conflicts, tt)
2407
return conflicts, merge_modified
2410
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2411
backups, merge_modified, basis_tree=None):
2412
if basis_tree is not None:
2413
basis_tree.lock_read()
2414
change_list = target_tree.iter_changes(working_tree,
2415
specific_files=specific_files, pb=pb)
2416
if target_tree.get_root_id() is None:
2422
for id_num, (file_id, path, changed_content, versioned, parent, name,
2423
kind, executable) in enumerate(change_list):
2424
if skip_root and file_id[0] is not None and parent[0] is None:
2426
trans_id = tt.trans_id_file_id(file_id)
2429
keep_content = False
2430
if kind[0] == 'file' and (backups or kind[1] is None):
2431
wt_sha1 = working_tree.get_file_sha1(file_id)
2432
if merge_modified.get(file_id) != wt_sha1:
2433
# acquire the basis tree lazily to prevent the
2434
# expense of accessing it when it's not needed ?
2435
# (Guessing, RBC, 200702)
2436
if basis_tree is None:
2437
basis_tree = working_tree.basis_tree()
2438
basis_tree.lock_read()
2439
if file_id in basis_tree:
2440
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2442
elif kind[1] is None and not versioned[1]:
2444
if kind[0] is not None:
2445
if not keep_content:
2446
tt.delete_contents(trans_id)
2447
elif kind[1] is not None:
2448
parent_trans_id = tt.trans_id_file_id(parent[0])
2449
by_parent = tt.by_parent()
2450
backup_name = _get_backup_name(name[0], by_parent,
2451
parent_trans_id, tt)
2452
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2453
new_trans_id = tt.create_path(name[0], parent_trans_id)
2454
if versioned == (True, True):
2455
tt.unversion_file(trans_id)
2456
tt.version_file(file_id, new_trans_id)
2457
# New contents should have the same unix perms as old
2460
trans_id = new_trans_id
2461
if kind[1] in ('directory', 'tree-reference'):
2462
tt.create_directory(trans_id)
2463
if kind[1] == 'tree-reference':
2464
revision = target_tree.get_reference_revision(file_id,
2466
tt.set_tree_reference(revision, trans_id)
2467
elif kind[1] == 'symlink':
2468
tt.create_symlink(target_tree.get_symlink_target(file_id),
2470
elif kind[1] == 'file':
2471
deferred_files.append((file_id, (trans_id, mode_id)))
2472
if basis_tree is None:
2473
basis_tree = working_tree.basis_tree()
2474
basis_tree.lock_read()
2475
new_sha1 = target_tree.get_file_sha1(file_id)
2476
if (file_id in basis_tree and new_sha1 ==
2477
basis_tree.get_file_sha1(file_id)):
2478
if file_id in merge_modified:
2479
del merge_modified[file_id]
2481
merge_modified[file_id] = new_sha1
2483
# preserve the execute bit when backing up
2484
if keep_content and executable[0] == executable[1]:
2485
tt.set_executability(executable[1], trans_id)
2486
elif kind[1] is not None:
2487
raise AssertionError(kind[1])
2488
if versioned == (False, True):
2489
tt.version_file(file_id, trans_id)
2490
if versioned == (True, False):
2491
tt.unversion_file(trans_id)
2492
if (name[1] is not None and
2493
(name[0] != name[1] or parent[0] != parent[1])):
2494
if name[1] == '' and parent[1] is None:
2495
parent_trans = ROOT_PARENT
2497
parent_trans = tt.trans_id_file_id(parent[1])
2498
tt.adjust_path(name[1], parent_trans, trans_id)
2499
if executable[0] != executable[1] and kind[1] == "file":
2500
tt.set_executability(executable[1], trans_id)
2501
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2503
tt.create_file(bytes, trans_id, mode_id)
2505
if basis_tree is not None:
2507
return merge_modified
2510
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2511
"""Make many conflict-resolution attempts, but die if they fail"""
2512
if pass_func is None:
2513
pass_func = conflict_pass
2514
new_conflicts = set()
2517
pb.update('Resolution pass', n+1, 10)
2518
conflicts = tt.find_conflicts()
2519
if len(conflicts) == 0:
2520
return new_conflicts
2521
new_conflicts.update(pass_func(tt, conflicts))
2522
raise MalformedTransform(conflicts=conflicts)
2527
def conflict_pass(tt, conflicts, path_tree=None):
2528
"""Resolve some classes of conflicts.
2530
:param tt: The transform to resolve conflicts in
2531
:param conflicts: The conflicts to resolve
2532
:param path_tree: A Tree to get supplemental paths from
2534
new_conflicts = set()
2535
for c_type, conflict in ((c[0], c) for c in conflicts):
2536
if c_type == 'duplicate id':
2537
tt.unversion_file(conflict[1])
2538
new_conflicts.add((c_type, 'Unversioned existing file',
2539
conflict[1], conflict[2], ))
2540
elif c_type == 'duplicate':
2541
# files that were renamed take precedence
2542
final_parent = tt.final_parent(conflict[1])
2543
if tt.path_changed(conflict[1]):
2544
existing_file, new_file = conflict[2], conflict[1]
2546
existing_file, new_file = conflict[1], conflict[2]
2547
new_name = tt.final_name(existing_file)+'.moved'
2548
tt.adjust_path(new_name, final_parent, existing_file)
2549
new_conflicts.add((c_type, 'Moved existing file to',
2550
existing_file, new_file))
2551
elif c_type == 'parent loop':
2552
# break the loop by undoing one of the ops that caused the loop
2554
while not tt.path_changed(cur):
2555
cur = tt.final_parent(cur)
2556
new_conflicts.add((c_type, 'Cancelled move', cur,
2557
tt.final_parent(cur),))
2558
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2560
elif c_type == 'missing parent':
2561
trans_id = conflict[1]
2563
tt.cancel_deletion(trans_id)
2564
new_conflicts.add(('deleting parent', 'Not deleting',
2569
tt.final_name(trans_id)
2571
if path_tree is not None:
2572
file_id = tt.final_file_id(trans_id)
2574
file_id = tt.inactive_file_id(trans_id)
2575
entry = path_tree.inventory[file_id]
2576
# special-case the other tree root (move its
2577
# children to current root)
2578
if entry.parent_id is None:
2580
moved = _reparent_transform_children(
2581
tt, trans_id, tt.root)
2583
new_conflicts.add((c_type, 'Moved to root',
2586
parent_trans_id = tt.trans_id_file_id(
2588
tt.adjust_path(entry.name, parent_trans_id,
2591
tt.create_directory(trans_id)
2592
new_conflicts.add((c_type, 'Created directory', trans_id))
2593
elif c_type == 'unversioned parent':
2594
file_id = tt.inactive_file_id(conflict[1])
2595
# special-case the other tree root (move its children instead)
2596
if path_tree and file_id in path_tree:
2597
if path_tree.inventory[file_id].parent_id is None:
2599
tt.version_file(file_id, conflict[1])
2600
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2601
elif c_type == 'non-directory parent':
2602
parent_id = conflict[1]
2603
parent_parent = tt.final_parent(parent_id)
2604
parent_name = tt.final_name(parent_id)
2605
parent_file_id = tt.final_file_id(parent_id)
2606
new_parent_id = tt.new_directory(parent_name + '.new',
2607
parent_parent, parent_file_id)
2608
_reparent_transform_children(tt, parent_id, new_parent_id)
2609
if parent_file_id is not None:
2610
tt.unversion_file(parent_id)
2611
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2612
elif c_type == 'versioning no contents':
2613
tt.cancel_versioning(conflict[1])
2614
return new_conflicts
2617
def cook_conflicts(raw_conflicts, tt):
2618
"""Generate a list of cooked conflicts, sorted by file path"""
2619
from bzrlib.conflicts import Conflict
2620
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2621
return sorted(conflict_iter, key=Conflict.sort_key)
2624
def iter_cook_conflicts(raw_conflicts, tt):
2625
from bzrlib.conflicts import Conflict
2627
for conflict in raw_conflicts:
2628
c_type = conflict[0]
2629
action = conflict[1]
2630
modified_path = fp.get_path(conflict[2])
2631
modified_id = tt.final_file_id(conflict[2])
2632
if len(conflict) == 3:
2633
yield Conflict.factory(c_type, action=action, path=modified_path,
2634
file_id=modified_id)
2637
conflicting_path = fp.get_path(conflict[3])
2638
conflicting_id = tt.final_file_id(conflict[3])
2639
yield Conflict.factory(c_type, action=action, path=modified_path,
2640
file_id=modified_id,
2641
conflict_path=conflicting_path,
2642
conflict_file_id=conflicting_id)
2645
class _FileMover(object):
2646
"""Moves and deletes files for TreeTransform, tracking operations"""
2649
self.past_renames = []
2650
self.pending_deletions = []
2652
def rename(self, from_, to):
2653
"""Rename a file from one path to another. Functions like os.rename"""
2655
os.rename(from_, to)
2657
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2658
raise errors.FileExists(to, str(e))
2660
self.past_renames.append((from_, to))
2662
def pre_delete(self, from_, to):
2663
"""Rename a file out of the way and mark it for deletion.
2665
Unlike os.unlink, this works equally well for files and directories.
2666
:param from_: The current file path
2667
:param to: A temporary path for the file
2669
self.rename(from_, to)
2670
self.pending_deletions.append(to)
2673
"""Reverse all renames that have been performed"""
2674
for from_, to in reversed(self.past_renames):
2675
os.rename(to, from_)
2676
# after rollback, don't reuse _FileMover
2678
pending_deletions = None
2680
def apply_deletions(self):
2681
"""Apply all marked deletions"""
2682
for path in self.pending_deletions:
2684
# after apply_deletions, don't reuse _FileMover
2686
pending_deletions = None
added
removed
bzrlib/transform.py
