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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from stat import S_ISREG, S_IEXEC
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
31
revision as _mod_revision,
33
from bzrlib.util import bencode
35
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
36
ReusingTransform, NotVersionedError, CantMoveRoot,
37
ExistingLimbo, ImmortalLimbo, NoFinalPath,
39
from bzrlib.inventory import InventoryEntry
40
from bzrlib.osutils import (
50
from bzrlib.progress import DummyProgress, ProgressPhase
51
from bzrlib.symbol_versioning import (
55
from bzrlib.trace import mutter, warning
56
from bzrlib import tree
58
import bzrlib.urlutils as urlutils
61
ROOT_PARENT = "root-parent"
64
def unique_add(map, key, value):
66
raise DuplicateKey(key=key)
70
class _TransformResults(object):
71
def __init__(self, modified_paths, rename_count):
73
self.modified_paths = modified_paths
74
self.rename_count = rename_count
77
class TreeTransformBase(object):
78
"""The base class for TreeTransform and TreeTransformBase"""
80
def __init__(self, tree, limbodir, pb=DummyProgress(),
84
:param tree: The tree that will be transformed, but not necessarily
86
:param limbodir: A directory where new files can be stored until
87
they are installed in their proper places
88
:param pb: A ProgressBar indicating how much progress is being made
89
:param case_sensitive: If True, the target of the transform is
90
case sensitive, not just case preserving.
94
self._limbodir = limbodir
95
self._deletiondir = None
97
# mapping of trans_id -> new basename
99
# mapping of trans_id -> new parent trans_id
100
self._new_parent = {}
101
# mapping of trans_id with new contents -> new file_kind
102
self._new_contents = {}
103
# A mapping of transform ids to their limbo filename
104
self._limbo_files = {}
105
# A mapping of transform ids to a set of the transform ids of children
106
# that their limbo directory has
107
self._limbo_children = {}
108
# Map transform ids to maps of child filename to child transform id
109
self._limbo_children_names = {}
110
# List of transform ids that need to be renamed from limbo into place
111
self._needs_rename = set()
112
# Set of trans_ids whose contents will be removed
113
self._removed_contents = set()
114
# Mapping of trans_id -> new execute-bit value
115
self._new_executability = {}
116
# Mapping of trans_id -> new tree-reference value
117
self._new_reference_revision = {}
118
# Mapping of trans_id -> new file_id
120
# Mapping of old file-id -> trans_id
121
self._non_present_ids = {}
122
# Mapping of new file_id -> trans_id
124
# Set of file_ids that will be removed
125
self._removed_id = set()
126
# Mapping of path in old tree -> trans_id
127
self._tree_path_ids = {}
128
# Mapping trans_id -> path in old tree
129
self._tree_id_paths = {}
130
# Cache of realpath results, to speed up canonical_path
132
# Cache of relpath results, to speed up canonical_path
134
# The trans_id that will be used as the tree root
135
root_id = tree.get_root_id()
136
if root_id is not None:
137
self._new_root = self.trans_id_tree_file_id(root_id)
139
self._new_root = None
140
# Indictor of whether the transform has been applied
144
# Whether the target is case sensitive
145
self._case_sensitive_target = case_sensitive
146
# A counter of how many files have been renamed
147
self.rename_count = 0
149
def __get_root(self):
150
return self._new_root
152
root = property(__get_root)
155
"""Release the working tree lock, if held, clean up limbo dir.
157
This is required if apply has not been invoked, but can be invoked
160
if self._tree is None:
163
entries = [(self._limbo_name(t), t, k) for t, k in
164
self._new_contents.iteritems()]
165
entries.sort(reverse=True)
166
for path, trans_id, kind in entries:
167
if kind == "directory":
172
os.rmdir(self._limbodir)
174
# We don't especially care *why* the dir is immortal.
175
raise ImmortalLimbo(self._limbodir)
177
if self._deletiondir is not None:
178
os.rmdir(self._deletiondir)
180
raise errors.ImmortalPendingDeletion(self._deletiondir)
185
def _assign_id(self):
186
"""Produce a new tranform id"""
187
new_id = "new-%s" % self._id_number
191
def create_path(self, name, parent):
192
"""Assign a transaction id to a new path"""
193
trans_id = self._assign_id()
194
unique_add(self._new_name, trans_id, name)
195
unique_add(self._new_parent, trans_id, parent)
198
def adjust_path(self, name, parent, trans_id):
199
"""Change the path that is assigned to a transaction id."""
200
if trans_id == self._new_root:
202
previous_parent = self._new_parent.get(trans_id)
203
previous_name = self._new_name.get(trans_id)
204
self._new_name[trans_id] = name
205
self._new_parent[trans_id] = parent
206
if parent == ROOT_PARENT:
207
if self._new_root is not None:
208
raise ValueError("Cannot have multiple roots.")
209
self._new_root = trans_id
210
if (trans_id in self._limbo_files and
211
trans_id not in self._needs_rename):
212
self._rename_in_limbo([trans_id])
213
self._limbo_children[previous_parent].remove(trans_id)
214
del self._limbo_children_names[previous_parent][previous_name]
216
def _rename_in_limbo(self, trans_ids):
217
"""Fix limbo names so that the right final path is produced.
219
This means we outsmarted ourselves-- we tried to avoid renaming
220
these files later by creating them with their final names in their
221
final parents. But now the previous name or parent is no longer
222
suitable, so we have to rename them.
224
Even for trans_ids that have no new contents, we must remove their
225
entries from _limbo_files, because they are now stale.
227
for trans_id in trans_ids:
228
old_path = self._limbo_files.pop(trans_id)
229
if trans_id not in self._new_contents:
231
new_path = self._limbo_name(trans_id)
232
os.rename(old_path, new_path)
234
def adjust_root_path(self, name, parent):
235
"""Emulate moving the root by moving all children, instead.
237
We do this by undoing the association of root's transaction id with the
238
current tree. This allows us to create a new directory with that
239
transaction id. We unversion the root directory and version the
240
physically new directory, and hope someone versions the tree root
243
old_root = self._new_root
244
old_root_file_id = self.final_file_id(old_root)
245
# force moving all children of root
246
for child_id in self.iter_tree_children(old_root):
247
if child_id != parent:
248
self.adjust_path(self.final_name(child_id),
249
self.final_parent(child_id), child_id)
250
file_id = self.final_file_id(child_id)
251
if file_id is not None:
252
self.unversion_file(child_id)
253
self.version_file(file_id, child_id)
255
# the physical root needs a new transaction id
256
self._tree_path_ids.pop("")
257
self._tree_id_paths.pop(old_root)
258
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
259
if parent == old_root:
260
parent = self._new_root
261
self.adjust_path(name, parent, old_root)
262
self.create_directory(old_root)
263
self.version_file(old_root_file_id, old_root)
264
self.unversion_file(self._new_root)
266
def trans_id_tree_file_id(self, inventory_id):
267
"""Determine the transaction id of a working tree file.
269
This reflects only files that already exist, not ones that will be
270
added by transactions.
272
if inventory_id is None:
273
raise ValueError('None is not a valid file id')
274
path = self._tree.id2path(inventory_id)
275
return self.trans_id_tree_path(path)
277
def trans_id_file_id(self, file_id):
278
"""Determine or set the transaction id associated with a file ID.
279
A new id is only created for file_ids that were never present. If
280
a transaction has been unversioned, it is deliberately still returned.
281
(this will likely lead to an unversioned parent conflict.)
284
raise ValueError('None is not a valid file id')
285
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
286
return self._r_new_id[file_id]
289
self._tree.iter_entries_by_dir([file_id]).next()
290
except StopIteration:
291
if file_id in self._non_present_ids:
292
return self._non_present_ids[file_id]
294
trans_id = self._assign_id()
295
self._non_present_ids[file_id] = trans_id
298
return self.trans_id_tree_file_id(file_id)
300
def canonical_path(self, path):
301
"""Get the canonical tree-relative path"""
302
# don't follow final symlinks
303
abs = self._tree.abspath(path)
304
if abs in self._relpaths:
305
return self._relpaths[abs]
306
dirname, basename = os.path.split(abs)
307
if dirname not in self._realpaths:
308
self._realpaths[dirname] = os.path.realpath(dirname)
309
dirname = self._realpaths[dirname]
310
abs = pathjoin(dirname, basename)
311
if dirname in self._relpaths:
312
relpath = pathjoin(self._relpaths[dirname], basename)
313
relpath = relpath.rstrip('/\\')
315
relpath = self._tree.relpath(abs)
316
self._relpaths[abs] = relpath
319
def trans_id_tree_path(self, path):
320
"""Determine (and maybe set) the transaction ID for a tree path."""
321
path = self.canonical_path(path)
322
if path not in self._tree_path_ids:
323
self._tree_path_ids[path] = self._assign_id()
324
self._tree_id_paths[self._tree_path_ids[path]] = path
325
return self._tree_path_ids[path]
327
def get_tree_parent(self, trans_id):
328
"""Determine id of the parent in the tree."""
329
path = self._tree_id_paths[trans_id]
332
return self.trans_id_tree_path(os.path.dirname(path))
334
def create_file(self, contents, trans_id, mode_id=None):
335
"""Schedule creation of a new file.
339
Contents is an iterator of strings, all of which will be written
340
to the target destination.
342
New file takes the permissions of any existing file with that id,
343
unless mode_id is specified.
345
name = self._limbo_name(trans_id)
349
unique_add(self._new_contents, trans_id, 'file')
351
# Clean up the file, it never got registered so
352
# TreeTransform.finalize() won't clean it up.
357
f.writelines(contents)
360
self._set_mode(trans_id, mode_id, S_ISREG)
362
def _set_mode(self, trans_id, mode_id, typefunc):
363
"""Set the mode of new file contents.
364
The mode_id is the existing file to get the mode from (often the same
365
as trans_id). The operation is only performed if there's a mode match
366
according to typefunc.
371
old_path = self._tree_id_paths[mode_id]
375
mode = os.stat(self._tree.abspath(old_path)).st_mode
377
if e.errno in (errno.ENOENT, errno.ENOTDIR):
378
# Either old_path doesn't exist, or the parent of the
379
# target is not a directory (but will be one eventually)
380
# Either way, we know it doesn't exist *right now*
381
# See also bug #248448
386
os.chmod(self._limbo_name(trans_id), mode)
388
def create_hardlink(self, path, trans_id):
389
"""Schedule creation of a hard link"""
390
name = self._limbo_name(trans_id)
394
if e.errno != errno.EPERM:
396
raise errors.HardLinkNotSupported(path)
398
unique_add(self._new_contents, trans_id, 'file')
400
# Clean up the file, it never got registered so
401
# TreeTransform.finalize() won't clean it up.
405
def create_directory(self, trans_id):
406
"""Schedule creation of a new directory.
408
See also new_directory.
410
os.mkdir(self._limbo_name(trans_id))
411
unique_add(self._new_contents, trans_id, 'directory')
413
def create_symlink(self, target, trans_id):
414
"""Schedule creation of a new symbolic link.
416
target is a bytestring.
417
See also new_symlink.
420
os.symlink(target, self._limbo_name(trans_id))
421
unique_add(self._new_contents, trans_id, 'symlink')
424
path = FinalPaths(self).get_path(trans_id)
427
raise UnableCreateSymlink(path=path)
429
def cancel_creation(self, trans_id):
430
"""Cancel the creation of new file contents."""
431
del self._new_contents[trans_id]
432
children = self._limbo_children.get(trans_id)
433
# if this is a limbo directory with children, move them before removing
435
if children is not None:
436
self._rename_in_limbo(children)
437
del self._limbo_children[trans_id]
438
del self._limbo_children_names[trans_id]
439
delete_any(self._limbo_name(trans_id))
441
def delete_contents(self, trans_id):
442
"""Schedule the contents of a path entry for deletion"""
443
self.tree_kind(trans_id)
444
self._removed_contents.add(trans_id)
446
def cancel_deletion(self, trans_id):
447
"""Cancel a scheduled deletion"""
448
self._removed_contents.remove(trans_id)
450
def unversion_file(self, trans_id):
451
"""Schedule a path entry to become unversioned"""
452
self._removed_id.add(trans_id)
454
def delete_versioned(self, trans_id):
455
"""Delete and unversion a versioned file"""
456
self.delete_contents(trans_id)
457
self.unversion_file(trans_id)
459
def set_executability(self, executability, trans_id):
460
"""Schedule setting of the 'execute' bit
461
To unschedule, set to None
463
if executability is None:
464
del self._new_executability[trans_id]
466
unique_add(self._new_executability, trans_id, executability)
468
def set_tree_reference(self, revision_id, trans_id):
469
"""Set the reference associated with a directory"""
470
unique_add(self._new_reference_revision, trans_id, revision_id)
472
def version_file(self, file_id, trans_id):
473
"""Schedule a file to become versioned."""
476
unique_add(self._new_id, trans_id, file_id)
477
unique_add(self._r_new_id, file_id, trans_id)
479
def cancel_versioning(self, trans_id):
480
"""Undo a previous versioning of a file"""
481
file_id = self._new_id[trans_id]
482
del self._new_id[trans_id]
483
del self._r_new_id[file_id]
485
def new_paths(self, filesystem_only=False):
486
"""Determine the paths of all new and changed files.
488
:param filesystem_only: if True, only calculate values for files
489
that require renames or execute bit changes.
493
stale_ids = self._needs_rename.difference(self._new_name)
494
stale_ids.difference_update(self._new_parent)
495
stale_ids.difference_update(self._new_contents)
496
stale_ids.difference_update(self._new_id)
497
needs_rename = self._needs_rename.difference(stale_ids)
498
id_sets = (needs_rename, self._new_executability)
500
id_sets = (self._new_name, self._new_parent, self._new_contents,
501
self._new_id, self._new_executability)
502
for id_set in id_sets:
503
new_ids.update(id_set)
504
return sorted(FinalPaths(self).get_paths(new_ids))
506
def _inventory_altered(self):
507
"""Get the trans_ids and paths of files needing new inv entries."""
509
for id_set in [self._new_name, self._new_parent, self._new_id,
510
self._new_executability]:
511
new_ids.update(id_set)
512
changed_kind = set(self._removed_contents)
513
changed_kind.intersection_update(self._new_contents)
514
changed_kind.difference_update(new_ids)
515
changed_kind = (t for t in changed_kind if self.tree_kind(t) !=
517
new_ids.update(changed_kind)
518
return sorted(FinalPaths(self).get_paths(new_ids))
520
def tree_kind(self, trans_id):
521
"""Determine the file kind in the working tree.
523
Raises NoSuchFile if the file does not exist
525
path = self._tree_id_paths.get(trans_id)
527
raise NoSuchFile(None)
529
return file_kind(self._tree.abspath(path))
531
if e.errno != errno.ENOENT:
534
raise NoSuchFile(path)
536
def final_kind(self, trans_id):
537
"""Determine the final file kind, after any changes applied.
539
Raises NoSuchFile if the file does not exist/has no contents.
540
(It is conceivable that a path would be created without the
541
corresponding contents insertion command)
543
if trans_id in self._new_contents:
544
return self._new_contents[trans_id]
545
elif trans_id in self._removed_contents:
546
raise NoSuchFile(None)
548
return self.tree_kind(trans_id)
550
def tree_file_id(self, trans_id):
551
"""Determine the file id associated with the trans_id in the tree"""
553
path = self._tree_id_paths[trans_id]
555
# the file is a new, unversioned file, or invalid trans_id
557
# the file is old; the old id is still valid
558
if self._new_root == trans_id:
559
return self._tree.get_root_id()
560
return self._tree.path2id(path)
562
def final_file_id(self, trans_id):
563
"""Determine the file id after any changes are applied, or None.
565
None indicates that the file will not be versioned after changes are
569
return self._new_id[trans_id]
571
if trans_id in self._removed_id:
573
return self.tree_file_id(trans_id)
575
def inactive_file_id(self, trans_id):
576
"""Return the inactive file_id associated with a transaction id.
577
That is, the one in the tree or in non_present_ids.
578
The file_id may actually be active, too.
580
file_id = self.tree_file_id(trans_id)
581
if file_id is not None:
583
for key, value in self._non_present_ids.iteritems():
584
if value == trans_id:
587
def final_parent(self, trans_id):
588
"""Determine the parent file_id, after any changes are applied.
590
ROOT_PARENT is returned for the tree root.
593
return self._new_parent[trans_id]
595
return self.get_tree_parent(trans_id)
597
def final_name(self, trans_id):
598
"""Determine the final filename, after all changes are applied."""
600
return self._new_name[trans_id]
603
return os.path.basename(self._tree_id_paths[trans_id])
605
raise NoFinalPath(trans_id, self)
608
"""Return a map of parent: children for known parents.
610
Only new paths and parents of tree files with assigned ids are used.
613
items = list(self._new_parent.iteritems())
614
items.extend((t, self.final_parent(t)) for t in
615
self._tree_id_paths.keys())
616
for trans_id, parent_id in items:
617
if parent_id not in by_parent:
618
by_parent[parent_id] = set()
619
by_parent[parent_id].add(trans_id)
622
def path_changed(self, trans_id):
623
"""Return True if a trans_id's path has changed."""
624
return (trans_id in self._new_name) or (trans_id in self._new_parent)
626
def new_contents(self, trans_id):
627
return (trans_id in self._new_contents)
629
def find_conflicts(self):
630
"""Find any violations of inventory or filesystem invariants"""
631
if self._done is True:
632
raise ReusingTransform()
634
# ensure all children of all existent parents are known
635
# all children of non-existent parents are known, by definition.
636
self._add_tree_children()
637
by_parent = self.by_parent()
638
conflicts.extend(self._unversioned_parents(by_parent))
639
conflicts.extend(self._parent_loops())
640
conflicts.extend(self._duplicate_entries(by_parent))
641
conflicts.extend(self._duplicate_ids())
642
conflicts.extend(self._parent_type_conflicts(by_parent))
643
conflicts.extend(self._improper_versioning())
644
conflicts.extend(self._executability_conflicts())
645
conflicts.extend(self._overwrite_conflicts())
648
def _add_tree_children(self):
649
"""Add all the children of all active parents to the known paths.
651
Active parents are those which gain children, and those which are
652
removed. This is a necessary first step in detecting conflicts.
654
parents = self.by_parent().keys()
655
parents.extend([t for t in self._removed_contents if
656
self.tree_kind(t) == 'directory'])
657
for trans_id in self._removed_id:
658
file_id = self.tree_file_id(trans_id)
659
if file_id is not None:
660
if self._tree.inventory[file_id].kind == 'directory':
661
parents.append(trans_id)
662
elif self.tree_kind(trans_id) == 'directory':
663
parents.append(trans_id)
665
for parent_id in parents:
666
# ensure that all children are registered with the transaction
667
list(self.iter_tree_children(parent_id))
669
def iter_tree_children(self, parent_id):
670
"""Iterate through the entry's tree children, if any"""
672
path = self._tree_id_paths[parent_id]
676
children = os.listdir(self._tree.abspath(path))
678
if not (osutils._is_error_enotdir(e)
679
or e.errno in (errno.ENOENT, errno.ESRCH)):
683
for child in children:
684
childpath = joinpath(path, child)
685
if self._tree.is_control_filename(childpath):
687
yield self.trans_id_tree_path(childpath)
689
def has_named_child(self, by_parent, parent_id, name):
691
children = by_parent[parent_id]
694
for child in children:
695
if self.final_name(child) == name:
698
path = self._tree_id_paths[parent_id]
701
childpath = joinpath(path, name)
702
child_id = self._tree_path_ids.get(childpath)
704
return lexists(self._tree.abspath(childpath))
706
if self.final_parent(child_id) != parent_id:
708
if child_id in self._removed_contents:
709
# XXX What about dangling file-ids?
714
def _parent_loops(self):
715
"""No entry should be its own ancestor"""
717
for trans_id in self._new_parent:
720
while parent_id is not ROOT_PARENT:
723
parent_id = self.final_parent(parent_id)
726
if parent_id == trans_id:
727
conflicts.append(('parent loop', trans_id))
728
if parent_id in seen:
732
def _unversioned_parents(self, by_parent):
733
"""If parent directories are versioned, children must be versioned."""
735
for parent_id, children in by_parent.iteritems():
736
if parent_id is ROOT_PARENT:
738
if self.final_file_id(parent_id) is not None:
740
for child_id in children:
741
if self.final_file_id(child_id) is not None:
742
conflicts.append(('unversioned parent', parent_id))
746
def _improper_versioning(self):
747
"""Cannot version a file with no contents, or a bad type.
749
However, existing entries with no contents are okay.
752
for trans_id in self._new_id.iterkeys():
754
kind = self.final_kind(trans_id)
756
conflicts.append(('versioning no contents', trans_id))
758
if not InventoryEntry.versionable_kind(kind):
759
conflicts.append(('versioning bad kind', trans_id, kind))
762
def _executability_conflicts(self):
763
"""Check for bad executability changes.
765
Only versioned files may have their executability set, because
766
1. only versioned entries can have executability under windows
767
2. only files can be executable. (The execute bit on a directory
768
does not indicate searchability)
771
for trans_id in self._new_executability:
772
if self.final_file_id(trans_id) is None:
773
conflicts.append(('unversioned executability', trans_id))
776
non_file = self.final_kind(trans_id) != "file"
780
conflicts.append(('non-file executability', trans_id))
783
def _overwrite_conflicts(self):
784
"""Check for overwrites (not permitted on Win32)"""
786
for trans_id in self._new_contents:
788
self.tree_kind(trans_id)
791
if trans_id not in self._removed_contents:
792
conflicts.append(('overwrite', trans_id,
793
self.final_name(trans_id)))
796
def _duplicate_entries(self, by_parent):
797
"""No directory may have two entries with the same name."""
799
if (self._new_name, self._new_parent) == ({}, {}):
801
for children in by_parent.itervalues():
802
name_ids = [(self.final_name(t), t) for t in children]
803
if not self._case_sensitive_target:
804
name_ids = [(n.lower(), t) for n, t in name_ids]
808
for name, trans_id in name_ids:
810
kind = self.final_kind(trans_id)
813
file_id = self.final_file_id(trans_id)
814
if kind is None and file_id is None:
816
if name == last_name:
817
conflicts.append(('duplicate', last_trans_id, trans_id,
820
last_trans_id = trans_id
823
def _duplicate_ids(self):
824
"""Each inventory id may only be used once"""
826
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
828
all_ids = self._tree.all_file_ids()
829
active_tree_ids = all_ids.difference(removed_tree_ids)
830
for trans_id, file_id in self._new_id.iteritems():
831
if file_id in active_tree_ids:
832
old_trans_id = self.trans_id_tree_file_id(file_id)
833
conflicts.append(('duplicate id', old_trans_id, trans_id))
836
def _parent_type_conflicts(self, by_parent):
837
"""parents must have directory 'contents'."""
839
for parent_id, children in by_parent.iteritems():
840
if parent_id is ROOT_PARENT:
842
if not self._any_contents(children):
844
for child in children:
846
self.final_kind(child)
850
kind = self.final_kind(parent_id)
854
conflicts.append(('missing parent', parent_id))
855
elif kind != "directory":
856
conflicts.append(('non-directory parent', parent_id))
859
def _any_contents(self, trans_ids):
860
"""Return true if any of the trans_ids, will have contents."""
861
for trans_id in trans_ids:
863
kind = self.final_kind(trans_id)
869
def _limbo_name(self, trans_id):
870
"""Generate the limbo name of a file"""
871
limbo_name = self._limbo_files.get(trans_id)
872
if limbo_name is not None:
874
parent = self._new_parent.get(trans_id)
875
# if the parent directory is already in limbo (e.g. when building a
876
# tree), choose a limbo name inside the parent, to reduce further
878
use_direct_path = False
879
if self._new_contents.get(parent) == 'directory':
880
filename = self._new_name.get(trans_id)
881
if filename is not None:
882
if parent not in self._limbo_children:
883
self._limbo_children[parent] = set()
884
self._limbo_children_names[parent] = {}
885
use_direct_path = True
886
# the direct path can only be used if no other file has
887
# already taken this pathname, i.e. if the name is unused, or
888
# if it is already associated with this trans_id.
889
elif self._case_sensitive_target:
890
if (self._limbo_children_names[parent].get(filename)
891
in (trans_id, None)):
892
use_direct_path = True
894
for l_filename, l_trans_id in\
895
self._limbo_children_names[parent].iteritems():
896
if l_trans_id == trans_id:
898
if l_filename.lower() == filename.lower():
901
use_direct_path = True
904
limbo_name = pathjoin(self._limbo_files[parent], filename)
905
self._limbo_children[parent].add(trans_id)
906
self._limbo_children_names[parent][filename] = trans_id
908
limbo_name = pathjoin(self._limbodir, trans_id)
909
self._needs_rename.add(trans_id)
910
self._limbo_files[trans_id] = limbo_name
913
def _set_executability(self, path, trans_id):
914
"""Set the executability of versioned files """
915
if supports_executable():
916
new_executability = self._new_executability[trans_id]
917
abspath = self._tree.abspath(path)
918
current_mode = os.stat(abspath).st_mode
919
if new_executability:
922
to_mode = current_mode | (0100 & ~umask)
923
# Enable x-bit for others only if they can read it.
924
if current_mode & 0004:
925
to_mode |= 0001 & ~umask
926
if current_mode & 0040:
927
to_mode |= 0010 & ~umask
929
to_mode = current_mode & ~0111
930
os.chmod(abspath, to_mode)
932
def _new_entry(self, name, parent_id, file_id):
933
"""Helper function to create a new filesystem entry."""
934
trans_id = self.create_path(name, parent_id)
935
if file_id is not None:
936
self.version_file(file_id, trans_id)
939
def new_file(self, name, parent_id, contents, file_id=None,
941
"""Convenience method to create files.
943
name is the name of the file to create.
944
parent_id is the transaction id of the parent directory of the file.
945
contents is an iterator of bytestrings, which will be used to produce
947
:param file_id: The inventory ID of the file, if it is to be versioned.
948
:param executable: Only valid when a file_id has been supplied.
950
trans_id = self._new_entry(name, parent_id, file_id)
951
# TODO: rather than scheduling a set_executable call,
952
# have create_file create the file with the right mode.
953
self.create_file(contents, trans_id)
954
if executable is not None:
955
self.set_executability(executable, trans_id)
958
def new_directory(self, name, parent_id, file_id=None):
959
"""Convenience method to create directories.
961
name is the name of the directory to create.
962
parent_id is the transaction id of the parent directory of the
964
file_id is the inventory ID of the directory, if it is to be versioned.
966
trans_id = self._new_entry(name, parent_id, file_id)
967
self.create_directory(trans_id)
970
def new_symlink(self, name, parent_id, target, file_id=None):
971
"""Convenience method to create symbolic link.
973
name is the name of the symlink to create.
974
parent_id is the transaction id of the parent directory of the symlink.
975
target is a bytestring of the target of the symlink.
976
file_id is the inventory ID of the file, if it is to be versioned.
978
trans_id = self._new_entry(name, parent_id, file_id)
979
self.create_symlink(target, trans_id)
982
def _affected_ids(self):
983
"""Return the set of transform ids affected by the transform"""
984
trans_ids = set(self._removed_id)
985
trans_ids.update(self._new_id.keys())
986
trans_ids.update(self._removed_contents)
987
trans_ids.update(self._new_contents.keys())
988
trans_ids.update(self._new_executability.keys())
989
trans_ids.update(self._new_name.keys())
990
trans_ids.update(self._new_parent.keys())
993
def _get_file_id_maps(self):
994
"""Return mapping of file_ids to trans_ids in the to and from states"""
995
trans_ids = self._affected_ids()
998
# Build up two dicts: trans_ids associated with file ids in the
999
# FROM state, vs the TO state.
1000
for trans_id in trans_ids:
1001
from_file_id = self.tree_file_id(trans_id)
1002
if from_file_id is not None:
1003
from_trans_ids[from_file_id] = trans_id
1004
to_file_id = self.final_file_id(trans_id)
1005
if to_file_id is not None:
1006
to_trans_ids[to_file_id] = trans_id
1007
return from_trans_ids, to_trans_ids
1009
def _from_file_data(self, from_trans_id, from_versioned, file_id):
1010
"""Get data about a file in the from (tree) state
1012
Return a (name, parent, kind, executable) tuple
1014
from_path = self._tree_id_paths.get(from_trans_id)
1016
# get data from working tree if versioned
1017
from_entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1018
from_name = from_entry.name
1019
from_parent = from_entry.parent_id
1022
if from_path is None:
1023
# File does not exist in FROM state
1027
# File exists, but is not versioned. Have to use path-
1029
from_name = os.path.basename(from_path)
1030
tree_parent = self.get_tree_parent(from_trans_id)
1031
from_parent = self.tree_file_id(tree_parent)
1032
if from_path is not None:
1033
from_kind, from_executable, from_stats = \
1034
self._tree._comparison_data(from_entry, from_path)
1037
from_executable = False
1038
return from_name, from_parent, from_kind, from_executable
1040
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
1041
"""Get data about a file in the to (target) state
1043
Return a (name, parent, kind, executable) tuple
1045
to_name = self.final_name(to_trans_id)
1047
to_kind = self.final_kind(to_trans_id)
1050
to_parent = self.final_file_id(self.final_parent(to_trans_id))
1051
if to_trans_id in self._new_executability:
1052
to_executable = self._new_executability[to_trans_id]
1053
elif to_trans_id == from_trans_id:
1054
to_executable = from_executable
1056
to_executable = False
1057
return to_name, to_parent, to_kind, to_executable
1059
def iter_changes(self):
1060
"""Produce output in the same format as Tree.iter_changes.
1062
Will produce nonsensical results if invoked while inventory/filesystem
1063
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1065
This reads the Transform, but only reproduces changes involving a
1066
file_id. Files that are not versioned in either of the FROM or TO
1067
states are not reflected.
1069
final_paths = FinalPaths(self)
1070
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1072
# Now iterate through all active file_ids
1073
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1075
from_trans_id = from_trans_ids.get(file_id)
1076
# find file ids, and determine versioning state
1077
if from_trans_id is None:
1078
from_versioned = False
1079
from_trans_id = to_trans_ids[file_id]
1081
from_versioned = True
1082
to_trans_id = to_trans_ids.get(file_id)
1083
if to_trans_id is None:
1084
to_versioned = False
1085
to_trans_id = from_trans_id
1089
from_name, from_parent, from_kind, from_executable = \
1090
self._from_file_data(from_trans_id, from_versioned, file_id)
1092
to_name, to_parent, to_kind, to_executable = \
1093
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1095
if not from_versioned:
1098
from_path = self._tree_id_paths.get(from_trans_id)
1099
if not to_versioned:
1102
to_path = final_paths.get_path(to_trans_id)
1103
if from_kind != to_kind:
1105
elif to_kind in ('file', 'symlink') and (
1106
to_trans_id != from_trans_id or
1107
to_trans_id in self._new_contents):
1109
if (not modified and from_versioned == to_versioned and
1110
from_parent==to_parent and from_name == to_name and
1111
from_executable == to_executable):
1113
results.append((file_id, (from_path, to_path), modified,
1114
(from_versioned, to_versioned),
1115
(from_parent, to_parent),
1116
(from_name, to_name),
1117
(from_kind, to_kind),
1118
(from_executable, to_executable)))
1119
return iter(sorted(results, key=lambda x:x[1]))
1121
def get_preview_tree(self):
1122
"""Return a tree representing the result of the transform.
1124
This tree only supports the subset of Tree functionality required
1125
by show_diff_trees. It must only be compared to tt._tree.
1127
return _PreviewTree(self)
1129
def _text_parent(self, trans_id):
1130
file_id = self.tree_file_id(trans_id)
1132
if file_id is None or self._tree.kind(file_id) != 'file':
1134
except errors.NoSuchFile:
1138
def _get_parents_texts(self, trans_id):
1139
"""Get texts for compression parents of this file."""
1140
file_id = self._text_parent(trans_id)
1143
return (self._tree.get_file_text(file_id),)
1145
def _get_parents_lines(self, trans_id):
1146
"""Get lines for compression parents of this file."""
1147
file_id = self._text_parent(trans_id)
1150
return (self._tree.get_file_lines(file_id),)
1152
def serialize(self, serializer):
1153
"""Serialize this TreeTransform.
1155
:param serializer: A Serialiser like pack.ContainerSerializer.
1157
new_name = dict((k, v.encode('utf-8')) for k, v in
1158
self._new_name.items())
1159
new_executability = dict((k, int(v)) for k, v in
1160
self._new_executability.items())
1161
tree_path_ids = dict((k.encode('utf-8'), v)
1162
for k, v in self._tree_path_ids.items())
1164
'_id_number': self._id_number,
1165
'_new_name': new_name,
1166
'_new_parent': self._new_parent,
1167
'_new_executability': new_executability,
1168
'_new_id': self._new_id,
1169
'_tree_path_ids': tree_path_ids,
1170
'_removed_id': list(self._removed_id),
1171
'_removed_contents': list(self._removed_contents),
1172
'_non_present_ids': self._non_present_ids,
1174
yield serializer.bytes_record(bencode.bencode(attribs),
1176
for trans_id, kind in self._new_contents.items():
1178
cur_file = open(self._limbo_name(trans_id), 'rb')
1180
lines = osutils.chunks_to_lines(cur_file.readlines())
1183
parents = self._get_parents_lines(trans_id)
1184
mpdiff = multiparent.MultiParent.from_lines(lines, parents)
1185
content = ''.join(mpdiff.to_patch())
1186
if kind == 'directory':
1188
if kind == 'symlink':
1189
content = os.readlink(self._limbo_name(trans_id))
1190
yield serializer.bytes_record(content, ((trans_id, kind),))
1193
def deserialize(self, records):
1194
"""Deserialize a stored TreeTransform.
1196
:param records: An iterable of (names, content) tuples, as per
1197
pack.ContainerPushParser.
1199
names, content = records.next()
1200
attribs = bencode.bdecode(content)
1201
self._id_number = attribs['_id_number']
1202
self._new_name = dict((k, v.decode('utf-8'))
1203
for k, v in attribs['_new_name'].items())
1204
self._new_parent = attribs['_new_parent']
1205
self._new_executability = dict((k, bool(v)) for k, v in
1206
attribs['_new_executability'].items())
1207
self._new_id = attribs['_new_id']
1208
self._r_new_id = dict((v, k) for k, v in self._new_id.items())
1209
self._tree_path_ids = {}
1210
self._tree_id_paths = {}
1211
for bytepath, trans_id in attribs['_tree_path_ids'].items():
1212
path = bytepath.decode('utf-8')
1213
self._tree_path_ids[path] = trans_id
1214
self._tree_id_paths[trans_id] = path
1215
self._removed_id = set(attribs['_removed_id'])
1216
self._removed_contents = set(attribs['_removed_contents'])
1217
self._non_present_ids = attribs['_non_present_ids']
1218
for ((trans_id, kind),), content in records:
1220
mpdiff = multiparent.MultiParent.from_patch(content)
1221
lines = mpdiff.to_lines(self._get_parents_texts(trans_id))
1222
self.create_file(lines, trans_id)
1223
if kind == 'directory':
1224
self.create_directory(trans_id)
1225
if kind == 'symlink':
1226
self.create_symlink(content.decode('utf-8'), trans_id)
1229
class TreeTransform(TreeTransformBase):
1230
"""Represent a tree transformation.
1232
This object is designed to support incremental generation of the transform,
1235
However, it gives optimum performance when parent directories are created
1236
before their contents. The transform is then able to put child files
1237
directly in their parent directory, avoiding later renames.
1239
It is easy to produce malformed transforms, but they are generally
1240
harmless. Attempting to apply a malformed transform will cause an
1241
exception to be raised before any modifications are made to the tree.
1243
Many kinds of malformed transforms can be corrected with the
1244
resolve_conflicts function. The remaining ones indicate programming error,
1245
such as trying to create a file with no path.
1247
Two sets of file creation methods are supplied. Convenience methods are:
1252
These are composed of the low-level methods:
1254
* create_file or create_directory or create_symlink
1258
Transform/Transaction ids
1259
-------------------------
1260
trans_ids are temporary ids assigned to all files involved in a transform.
1261
It's possible, even common, that not all files in the Tree have trans_ids.
1263
trans_ids are used because filenames and file_ids are not good enough
1264
identifiers; filenames change, and not all files have file_ids. File-ids
1265
are also associated with trans-ids, so that moving a file moves its
1268
trans_ids are only valid for the TreeTransform that generated them.
1272
Limbo is a temporary directory use to hold new versions of files.
1273
Files are added to limbo by create_file, create_directory, create_symlink,
1274
and their convenience variants (new_*). Files may be removed from limbo
1275
using cancel_creation. Files are renamed from limbo into their final
1276
location as part of TreeTransform.apply
1278
Limbo must be cleaned up, by either calling TreeTransform.apply or
1279
calling TreeTransform.finalize.
1281
Files are placed into limbo inside their parent directories, where
1282
possible. This reduces subsequent renames, and makes operations involving
1283
lots of files faster. This optimization is only possible if the parent
1284
directory is created *before* creating any of its children, so avoid
1285
creating children before parents, where possible.
1289
This temporary directory is used by _FileMover for storing files that are
1290
about to be deleted. In case of rollback, the files will be restored.
1291
FileMover does not delete files until it is sure that a rollback will not
1294
def __init__(self, tree, pb=DummyProgress()):
1295
"""Note: a tree_write lock is taken on the tree.
1297
Use TreeTransform.finalize() to release the lock (can be omitted if
1298
TreeTransform.apply() called).
1300
tree.lock_tree_write()
1303
limbodir = urlutils.local_path_from_url(
1304
tree._transport.abspath('limbo'))
1308
if e.errno == errno.EEXIST:
1309
raise ExistingLimbo(limbodir)
1310
deletiondir = urlutils.local_path_from_url(
1311
tree._transport.abspath('pending-deletion'))
1313
os.mkdir(deletiondir)
1315
if e.errno == errno.EEXIST:
1316
raise errors.ExistingPendingDeletion(deletiondir)
1321
TreeTransformBase.__init__(self, tree, limbodir, pb,
1322
tree.case_sensitive)
1323
self._deletiondir = deletiondir
1325
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1326
"""Apply all changes to the inventory and filesystem.
1328
If filesystem or inventory conflicts are present, MalformedTransform
1331
If apply succeeds, finalize is not necessary.
1333
:param no_conflicts: if True, the caller guarantees there are no
1334
conflicts, so no check is made.
1335
:param precomputed_delta: An inventory delta to use instead of
1337
:param _mover: Supply an alternate FileMover, for testing
1339
if not no_conflicts:
1340
conflicts = self.find_conflicts()
1341
if len(conflicts) != 0:
1342
raise MalformedTransform(conflicts=conflicts)
1343
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1345
if precomputed_delta is None:
1346
child_pb.update('Apply phase', 0, 2)
1347
inventory_delta = self._generate_inventory_delta()
1350
inventory_delta = precomputed_delta
1353
mover = _FileMover()
1357
child_pb.update('Apply phase', 0 + offset, 2 + offset)
1358
self._apply_removals(mover)
1359
child_pb.update('Apply phase', 1 + offset, 2 + offset)
1360
modified_paths = self._apply_insertions(mover)
1365
mover.apply_deletions()
1368
self._tree.apply_inventory_delta(inventory_delta)
1371
return _TransformResults(modified_paths, self.rename_count)
1373
def _generate_inventory_delta(self):
1374
"""Generate an inventory delta for the current transform."""
1375
inventory_delta = []
1376
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1377
new_paths = self._inventory_altered()
1378
total_entries = len(new_paths) + len(self._removed_id)
1380
for num, trans_id in enumerate(self._removed_id):
1382
child_pb.update('removing file', num, total_entries)
1383
if trans_id == self._new_root:
1384
file_id = self._tree.get_root_id()
1386
file_id = self.tree_file_id(trans_id)
1387
# File-id isn't really being deleted, just moved
1388
if file_id in self._r_new_id:
1390
path = self._tree_id_paths[trans_id]
1391
inventory_delta.append((path, None, file_id, None))
1392
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1394
entries = self._tree.iter_entries_by_dir(
1395
new_path_file_ids.values())
1396
old_paths = dict((e.file_id, p) for p, e in entries)
1398
for num, (path, trans_id) in enumerate(new_paths):
1400
child_pb.update('adding file',
1401
num + len(self._removed_id), total_entries)
1402
file_id = new_path_file_ids[trans_id]
1407
kind = self.final_kind(trans_id)
1409
kind = self._tree.stored_kind(file_id)
1410
parent_trans_id = self.final_parent(trans_id)
1411
parent_file_id = new_path_file_ids.get(parent_trans_id)
1412
if parent_file_id is None:
1413
parent_file_id = self.final_file_id(parent_trans_id)
1414
if trans_id in self._new_reference_revision:
1415
new_entry = inventory.TreeReference(
1417
self._new_name[trans_id],
1418
self.final_file_id(self._new_parent[trans_id]),
1419
None, self._new_reference_revision[trans_id])
1421
new_entry = inventory.make_entry(kind,
1422
self.final_name(trans_id),
1423
parent_file_id, file_id)
1424
old_path = old_paths.get(new_entry.file_id)
1425
new_executability = self._new_executability.get(trans_id)
1426
if new_executability is not None:
1427
new_entry.executable = new_executability
1428
inventory_delta.append(
1429
(old_path, path, new_entry.file_id, new_entry))
1432
return inventory_delta
1434
def _apply_removals(self, mover):
1435
"""Perform tree operations that remove directory/inventory names.
1437
That is, delete files that are to be deleted, and put any files that
1438
need renaming into limbo. This must be done in strict child-to-parent
1441
If inventory_delta is None, no inventory delta generation is performed.
1443
tree_paths = list(self._tree_path_ids.iteritems())
1444
tree_paths.sort(reverse=True)
1445
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1447
for num, data in enumerate(tree_paths):
1448
path, trans_id = data
1449
child_pb.update('removing file', num, len(tree_paths))
1450
full_path = self._tree.abspath(path)
1451
if trans_id in self._removed_contents:
1452
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1454
elif trans_id in self._new_name or trans_id in \
1457
mover.rename(full_path, self._limbo_name(trans_id))
1459
if e.errno != errno.ENOENT:
1462
self.rename_count += 1
1466
def _apply_insertions(self, mover):
1467
"""Perform tree operations that insert directory/inventory names.
1469
That is, create any files that need to be created, and restore from
1470
limbo any files that needed renaming. This must be done in strict
1471
parent-to-child order.
1473
If inventory_delta is None, no inventory delta is calculated, and
1474
no list of modified paths is returned.
1476
new_paths = self.new_paths(filesystem_only=True)
1478
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1480
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1482
for num, (path, trans_id) in enumerate(new_paths):
1484
child_pb.update('adding file', num, len(new_paths))
1485
full_path = self._tree.abspath(path)
1486
if trans_id in self._needs_rename:
1488
mover.rename(self._limbo_name(trans_id), full_path)
1490
# We may be renaming a dangling inventory id
1491
if e.errno != errno.ENOENT:
1494
self.rename_count += 1
1495
if (trans_id in self._new_contents or
1496
self.path_changed(trans_id)):
1497
if trans_id in self._new_contents:
1498
modified_paths.append(full_path)
1499
if trans_id in self._new_executability:
1500
self._set_executability(path, trans_id)
1503
self._new_contents.clear()
1504
return modified_paths
1507
class TransformPreview(TreeTransformBase):
1508
"""A TreeTransform for generating preview trees.
1510
Unlike TreeTransform, this version works when the input tree is a
1511
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1512
unversioned files in the input tree.
1515
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1517
limbodir = osutils.mkdtemp(prefix='bzr-limbo-')
1518
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1520
def canonical_path(self, path):
1523
def tree_kind(self, trans_id):
1524
path = self._tree_id_paths.get(trans_id)
1526
raise NoSuchFile(None)
1527
file_id = self._tree.path2id(path)
1528
return self._tree.kind(file_id)
1530
def _set_mode(self, trans_id, mode_id, typefunc):
1531
"""Set the mode of new file contents.
1532
The mode_id is the existing file to get the mode from (often the same
1533
as trans_id). The operation is only performed if there's a mode match
1534
according to typefunc.
1536
# is it ok to ignore this? probably
1539
def iter_tree_children(self, parent_id):
1540
"""Iterate through the entry's tree children, if any"""
1542
path = self._tree_id_paths[parent_id]
1545
file_id = self.tree_file_id(parent_id)
1548
entry = self._tree.iter_entries_by_dir([file_id]).next()[1]
1549
children = getattr(entry, 'children', {})
1550
for child in children:
1551
childpath = joinpath(path, child)
1552
yield self.trans_id_tree_path(childpath)
1555
class _PreviewTree(tree.Tree):
1556
"""Partial implementation of Tree to support show_diff_trees"""
1558
def __init__(self, transform):
1559
self._transform = transform
1560
self._final_paths = FinalPaths(transform)
1561
self.__by_parent = None
1562
self._parent_ids = []
1563
self._all_children_cache = {}
1564
self._path2trans_id_cache = {}
1565
self._final_name_cache = {}
1567
def _changes(self, file_id):
1568
for changes in self._transform.iter_changes():
1569
if changes[0] == file_id:
1572
def _content_change(self, file_id):
1573
"""Return True if the content of this file changed"""
1574
changes = self._changes(file_id)
1575
# changes[2] is true if the file content changed. See
1576
# InterTree.iter_changes.
1577
return (changes is not None and changes[2])
1579
def _get_repository(self):
1580
repo = getattr(self._transform._tree, '_repository', None)
1582
repo = self._transform._tree.branch.repository
1585
def _iter_parent_trees(self):
1586
for revision_id in self.get_parent_ids():
1588
yield self.revision_tree(revision_id)
1589
except errors.NoSuchRevisionInTree:
1590
yield self._get_repository().revision_tree(revision_id)
1592
def _get_file_revision(self, file_id, vf, tree_revision):
1593
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
1594
self._iter_parent_trees()]
1595
vf.add_lines((file_id, tree_revision), parent_keys,
1596
self.get_file(file_id).readlines())
1597
repo = self._get_repository()
1598
base_vf = repo.texts
1599
if base_vf not in vf.fallback_versionedfiles:
1600
vf.fallback_versionedfiles.append(base_vf)
1601
return tree_revision
1603
def _stat_limbo_file(self, file_id):
1604
trans_id = self._transform.trans_id_file_id(file_id)
1605
name = self._transform._limbo_name(trans_id)
1606
return os.lstat(name)
1609
def _by_parent(self):
1610
if self.__by_parent is None:
1611
self.__by_parent = self._transform.by_parent()
1612
return self.__by_parent
1614
def _comparison_data(self, entry, path):
1615
kind, size, executable, link_or_sha1 = self.path_content_summary(path)
1616
if kind == 'missing':
1620
file_id = self._transform.final_file_id(self._path2trans_id(path))
1621
executable = self.is_executable(file_id, path)
1622
return kind, executable, None
1624
def lock_read(self):
1625
# Perhaps in theory, this should lock the TreeTransform?
1632
def inventory(self):
1633
"""This Tree does not use inventory as its backing data."""
1634
raise NotImplementedError(_PreviewTree.inventory)
1636
def get_root_id(self):
1637
return self._transform.final_file_id(self._transform.root)
1639
def all_file_ids(self):
1640
tree_ids = set(self._transform._tree.all_file_ids())
1641
tree_ids.difference_update(self._transform.tree_file_id(t)
1642
for t in self._transform._removed_id)
1643
tree_ids.update(self._transform._new_id.values())
1647
return iter(self.all_file_ids())
1649
def has_id(self, file_id):
1650
if file_id in self._transform._r_new_id:
1652
elif file_id in self._transform._removed_id:
1655
return self._transform._tree.has_id(file_id)
1657
def _path2trans_id(self, path):
1658
# We must not use None here, because that is a valid value to store.
1659
trans_id = self._path2trans_id_cache.get(path, object)
1660
if trans_id is not object:
1662
segments = splitpath(path)
1663
cur_parent = self._transform.root
1664
for cur_segment in segments:
1665
for child in self._all_children(cur_parent):
1666
final_name = self._final_name_cache.get(child)
1667
if final_name is None:
1668
final_name = self._transform.final_name(child)
1669
self._final_name_cache[child] = final_name
1670
if final_name == cur_segment:
1674
self._path2trans_id_cache[path] = None
1676
self._path2trans_id_cache[path] = cur_parent
1679
def path2id(self, path):
1680
return self._transform.final_file_id(self._path2trans_id(path))
1682
def id2path(self, file_id):
1683
trans_id = self._transform.trans_id_file_id(file_id)
1685
return self._final_paths._determine_path(trans_id)
1687
raise errors.NoSuchId(self, file_id)
1689
def _all_children(self, trans_id):
1690
children = self._all_children_cache.get(trans_id)
1691
if children is not None:
1693
children = set(self._transform.iter_tree_children(trans_id))
1694
# children in the _new_parent set are provided by _by_parent.
1695
children.difference_update(self._transform._new_parent.keys())
1696
children.update(self._by_parent.get(trans_id, []))
1697
self._all_children_cache[trans_id] = children
1700
def iter_children(self, file_id):
1701
trans_id = self._transform.trans_id_file_id(file_id)
1702
for child_trans_id in self._all_children(trans_id):
1703
yield self._transform.final_file_id(child_trans_id)
1706
possible_extras = set(self._transform.trans_id_tree_path(p) for p
1707
in self._transform._tree.extras())
1708
possible_extras.update(self._transform._new_contents)
1709
possible_extras.update(self._transform._removed_id)
1710
for trans_id in possible_extras:
1711
if self._transform.final_file_id(trans_id) is None:
1712
yield self._final_paths._determine_path(trans_id)
1714
def _make_inv_entries(self, ordered_entries, specific_file_ids):
1715
for trans_id, parent_file_id in ordered_entries:
1716
file_id = self._transform.final_file_id(trans_id)
1719
if (specific_file_ids is not None
1720
and file_id not in specific_file_ids):
1723
kind = self._transform.final_kind(trans_id)
1725
kind = self._transform._tree.stored_kind(file_id)
1726
new_entry = inventory.make_entry(
1728
self._transform.final_name(trans_id),
1729
parent_file_id, file_id)
1730
yield new_entry, trans_id
1732
def _list_files_by_dir(self):
1733
todo = [ROOT_PARENT]
1735
while len(todo) > 0:
1737
parent_file_id = self._transform.final_file_id(parent)
1738
children = list(self._all_children(parent))
1739
paths = dict(zip(children, self._final_paths.get_paths(children)))
1740
children.sort(key=paths.get)
1741
todo.extend(reversed(children))
1742
for trans_id in children:
1743
ordered_ids.append((trans_id, parent_file_id))
1746
def iter_entries_by_dir(self, specific_file_ids=None):
1747
# This may not be a maximally efficient implementation, but it is
1748
# reasonably straightforward. An implementation that grafts the
1749
# TreeTransform changes onto the tree's iter_entries_by_dir results
1750
# might be more efficient, but requires tricky inferences about stack
1752
ordered_ids = self._list_files_by_dir()
1753
for entry, trans_id in self._make_inv_entries(ordered_ids,
1755
yield unicode(self._final_paths.get_path(trans_id)), entry
1757
def list_files(self, include_root=False):
1758
"""See Tree.list_files."""
1759
# XXX This should behave like WorkingTree.list_files, but is really
1760
# more like RevisionTree.list_files.
1761
for path, entry in self.iter_entries_by_dir():
1762
if entry.name == '' and not include_root:
1764
yield path, 'V', entry.kind, entry.file_id, entry
1766
def kind(self, file_id):
1767
trans_id = self._transform.trans_id_file_id(file_id)
1768
return self._transform.final_kind(trans_id)
1770
def stored_kind(self, file_id):
1771
trans_id = self._transform.trans_id_file_id(file_id)
1773
return self._transform._new_contents[trans_id]
1775
return self._transform._tree.stored_kind(file_id)
1777
def get_file_mtime(self, file_id, path=None):
1778
"""See Tree.get_file_mtime"""
1779
if not self._content_change(file_id):
1780
return self._transform._tree.get_file_mtime(file_id, path)
1781
return self._stat_limbo_file(file_id).st_mtime
1783
def _file_size(self, entry, stat_value):
1784
return self.get_file_size(entry.file_id)
1786
def get_file_size(self, file_id):
1787
"""See Tree.get_file_size"""
1788
if self.kind(file_id) == 'file':
1789
return self._transform._tree.get_file_size(file_id)
1793
def get_file_sha1(self, file_id, path=None, stat_value=None):
1794
trans_id = self._transform.trans_id_file_id(file_id)
1795
kind = self._transform._new_contents.get(trans_id)
1797
return self._transform._tree.get_file_sha1(file_id)
1799
fileobj = self.get_file(file_id)
1801
return sha_file(fileobj)
1805
def is_executable(self, file_id, path=None):
1808
trans_id = self._transform.trans_id_file_id(file_id)
1810
return self._transform._new_executability[trans_id]
1813
return self._transform._tree.is_executable(file_id, path)
1815
if e.errno == errno.ENOENT:
1818
except errors.NoSuchId:
1821
def path_content_summary(self, path):
1822
trans_id = self._path2trans_id(path)
1823
tt = self._transform
1824
tree_path = tt._tree_id_paths.get(trans_id)
1825
kind = tt._new_contents.get(trans_id)
1827
if tree_path is None or trans_id in tt._removed_contents:
1828
return 'missing', None, None, None
1829
summary = tt._tree.path_content_summary(tree_path)
1830
kind, size, executable, link_or_sha1 = summary
1833
limbo_name = tt._limbo_name(trans_id)
1834
if trans_id in tt._new_reference_revision:
1835
kind = 'tree-reference'
1837
statval = os.lstat(limbo_name)
1838
size = statval.st_size
1839
if not supports_executable():
1842
executable = statval.st_mode & S_IEXEC
1846
if kind == 'symlink':
1847
link_or_sha1 = os.readlink(limbo_name)
1848
if supports_executable():
1849
executable = tt._new_executability.get(trans_id, executable)
1850
return kind, size, executable, link_or_sha1
1852
def iter_changes(self, from_tree, include_unchanged=False,
1853
specific_files=None, pb=None, extra_trees=None,
1854
require_versioned=True, want_unversioned=False):
1855
"""See InterTree.iter_changes.
1857
This has a fast path that is only used when the from_tree matches
1858
the transform tree, and no fancy options are supplied.
1860
if (from_tree is not self._transform._tree or include_unchanged or
1861
specific_files or want_unversioned):
1862
return tree.InterTree(from_tree, self).iter_changes(
1863
include_unchanged=include_unchanged,
1864
specific_files=specific_files,
1866
extra_trees=extra_trees,
1867
require_versioned=require_versioned,
1868
want_unversioned=want_unversioned)
1869
if want_unversioned:
1870
raise ValueError('want_unversioned is not supported')
1871
return self._transform.iter_changes()
1873
def get_file(self, file_id, path=None):
1874
"""See Tree.get_file"""
1875
if not self._content_change(file_id):
1876
return self._transform._tree.get_file(file_id, path)
1877
trans_id = self._transform.trans_id_file_id(file_id)
1878
name = self._transform._limbo_name(trans_id)
1879
return open(name, 'rb')
1881
def annotate_iter(self, file_id,
1882
default_revision=_mod_revision.CURRENT_REVISION):
1883
changes = self._changes(file_id)
1887
changed_content, versioned, kind = (changes[2], changes[3],
1891
get_old = (kind[0] == 'file' and versioned[0])
1893
old_annotation = self._transform._tree.annotate_iter(file_id,
1894
default_revision=default_revision)
1898
return old_annotation
1899
if not changed_content:
1900
return old_annotation
1901
return annotate.reannotate([old_annotation],
1902
self.get_file(file_id).readlines(),
1905
def get_symlink_target(self, file_id):
1906
"""See Tree.get_symlink_target"""
1907
if not self._content_change(file_id):
1908
return self._transform._tree.get_symlink_target(file_id)
1909
trans_id = self._transform.trans_id_file_id(file_id)
1910
name = self._transform._limbo_name(trans_id)
1911
return os.readlink(name)
1913
def walkdirs(self, prefix=''):
1914
pending = [self._transform.root]
1915
while len(pending) > 0:
1916
parent_id = pending.pop()
1919
prefix = prefix.rstrip('/')
1920
parent_path = self._final_paths.get_path(parent_id)
1921
parent_file_id = self._transform.final_file_id(parent_id)
1922
for child_id in self._all_children(parent_id):
1923
path_from_root = self._final_paths.get_path(child_id)
1924
basename = self._transform.final_name(child_id)
1925
file_id = self._transform.final_file_id(child_id)
1927
kind = self._transform.final_kind(child_id)
1928
versioned_kind = kind
1931
versioned_kind = self._transform._tree.stored_kind(file_id)
1932
if versioned_kind == 'directory':
1933
subdirs.append(child_id)
1934
children.append((path_from_root, basename, kind, None,
1935
file_id, versioned_kind))
1937
if parent_path.startswith(prefix):
1938
yield (parent_path, parent_file_id), children
1939
pending.extend(sorted(subdirs, key=self._final_paths.get_path,
1942
def get_parent_ids(self):
1943
return self._parent_ids
1945
def set_parent_ids(self, parent_ids):
1946
self._parent_ids = parent_ids
1948
def get_revision_tree(self, revision_id):
1949
return self._transform._tree.get_revision_tree(revision_id)
1952
def joinpath(parent, child):
1953
"""Join tree-relative paths, handling the tree root specially"""
1954
if parent is None or parent == "":
1957
return pathjoin(parent, child)
1960
class FinalPaths(object):
1961
"""Make path calculation cheap by memoizing paths.
1963
The underlying tree must not be manipulated between calls, or else
1964
the results will likely be incorrect.
1966
def __init__(self, transform):
1967
object.__init__(self)
1968
self._known_paths = {}
1969
self.transform = transform
1971
def _determine_path(self, trans_id):
1972
if trans_id == self.transform.root:
1974
name = self.transform.final_name(trans_id)
1975
parent_id = self.transform.final_parent(trans_id)
1976
if parent_id == self.transform.root:
1979
return pathjoin(self.get_path(parent_id), name)
1981
def get_path(self, trans_id):
1982
"""Find the final path associated with a trans_id"""
1983
if trans_id not in self._known_paths:
1984
self._known_paths[trans_id] = self._determine_path(trans_id)
1985
return self._known_paths[trans_id]
1987
def get_paths(self, trans_ids):
1988
return [(self.get_path(t), t) for t in trans_ids]
1992
def topology_sorted_ids(tree):
1993
"""Determine the topological order of the ids in a tree"""
1994
file_ids = list(tree)
1995
file_ids.sort(key=tree.id2path)
1999
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
2000
delta_from_tree=False):
2001
"""Create working tree for a branch, using a TreeTransform.
2003
This function should be used on empty trees, having a tree root at most.
2004
(see merge and revert functionality for working with existing trees)
2006
Existing files are handled like so:
2008
- Existing bzrdirs take precedence over creating new items. They are
2009
created as '%s.diverted' % name.
2010
- Otherwise, if the content on disk matches the content we are building,
2011
it is silently replaced.
2012
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
2014
:param tree: The tree to convert wt into a copy of
2015
:param wt: The working tree that files will be placed into
2016
:param accelerator_tree: A tree which can be used for retrieving file
2017
contents more quickly than tree itself, i.e. a workingtree. tree
2018
will be used for cases where accelerator_tree's content is different.
2019
:param hardlink: If true, hard-link files to accelerator_tree, where
2020
possible. accelerator_tree must implement abspath, i.e. be a
2022
:param delta_from_tree: If true, build_tree may use the input Tree to
2023
generate the inventory delta.
2025
wt.lock_tree_write()
2029
if accelerator_tree is not None:
2030
accelerator_tree.lock_read()
2032
return _build_tree(tree, wt, accelerator_tree, hardlink,
2035
if accelerator_tree is not None:
2036
accelerator_tree.unlock()
2043
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
2044
"""See build_tree."""
2045
for num, _unused in enumerate(wt.all_file_ids()):
2046
if num > 0: # more than just a root
2047
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
2048
existing_files = set()
2049
for dir, files in wt.walkdirs():
2050
existing_files.update(f[0] for f in files)
2052
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2053
pp = ProgressPhase("Build phase", 2, top_pb)
2054
if tree.inventory.root is not None:
2055
# This is kind of a hack: we should be altering the root
2056
# as part of the regular tree shape diff logic.
2057
# The conditional test here is to avoid doing an
2058
# expensive operation (flush) every time the root id
2059
# is set within the tree, nor setting the root and thus
2060
# marking the tree as dirty, because we use two different
2061
# idioms here: tree interfaces and inventory interfaces.
2062
if wt.get_root_id() != tree.get_root_id():
2063
wt.set_root_id(tree.get_root_id())
2065
tt = TreeTransform(wt)
2069
file_trans_id[wt.get_root_id()] = \
2070
tt.trans_id_tree_file_id(wt.get_root_id())
2071
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2073
deferred_contents = []
2075
total = len(tree.inventory)
2077
precomputed_delta = []
2079
precomputed_delta = None
2080
for num, (tree_path, entry) in \
2081
enumerate(tree.inventory.iter_entries_by_dir()):
2082
pb.update("Building tree", num - len(deferred_contents), total)
2083
if entry.parent_id is None:
2086
file_id = entry.file_id
2088
precomputed_delta.append((None, tree_path, file_id, entry))
2089
if tree_path in existing_files:
2090
target_path = wt.abspath(tree_path)
2091
kind = file_kind(target_path)
2092
if kind == "directory":
2094
bzrdir.BzrDir.open(target_path)
2095
except errors.NotBranchError:
2099
if (file_id not in divert and
2100
_content_match(tree, entry, file_id, kind,
2102
tt.delete_contents(tt.trans_id_tree_path(tree_path))
2103
if kind == 'directory':
2105
parent_id = file_trans_id[entry.parent_id]
2106
if entry.kind == 'file':
2107
# We *almost* replicate new_by_entry, so that we can defer
2108
# getting the file text, and get them all at once.
2109
trans_id = tt.create_path(entry.name, parent_id)
2110
file_trans_id[file_id] = trans_id
2111
tt.version_file(file_id, trans_id)
2112
executable = tree.is_executable(file_id, tree_path)
2114
tt.set_executability(executable, trans_id)
2115
deferred_contents.append((file_id, trans_id))
2117
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
2120
new_trans_id = file_trans_id[file_id]
2121
old_parent = tt.trans_id_tree_path(tree_path)
2122
_reparent_children(tt, old_parent, new_trans_id)
2123
offset = num + 1 - len(deferred_contents)
2124
_create_files(tt, tree, deferred_contents, pb, offset,
2125
accelerator_tree, hardlink)
2129
divert_trans = set(file_trans_id[f] for f in divert)
2130
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
2131
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
2132
if len(raw_conflicts) > 0:
2133
precomputed_delta = None
2134
conflicts = cook_conflicts(raw_conflicts, tt)
2135
for conflict in conflicts:
2138
wt.add_conflicts(conflicts)
2139
except errors.UnsupportedOperation:
2141
result = tt.apply(no_conflicts=True,
2142
precomputed_delta=precomputed_delta)
2149
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
2151
total = len(desired_files) + offset
2152
if accelerator_tree is None:
2153
new_desired_files = desired_files
2155
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
2156
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
2157
in iter if not (c or e[0] != e[1]))
2158
new_desired_files = []
2160
for file_id, trans_id in desired_files:
2161
accelerator_path = unchanged.get(file_id)
2162
if accelerator_path is None:
2163
new_desired_files.append((file_id, trans_id))
2165
pb.update('Adding file contents', count + offset, total)
2167
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
2170
contents = accelerator_tree.get_file(file_id, accelerator_path)
2172
tt.create_file(contents, trans_id)
2177
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
2178
new_desired_files)):
2179
tt.create_file(contents, trans_id)
2180
pb.update('Adding file contents', count + offset, total)
2183
def _reparent_children(tt, old_parent, new_parent):
2184
for child in tt.iter_tree_children(old_parent):
2185
tt.adjust_path(tt.final_name(child), new_parent, child)
2187
def _reparent_transform_children(tt, old_parent, new_parent):
2188
by_parent = tt.by_parent()
2189
for child in by_parent[old_parent]:
2190
tt.adjust_path(tt.final_name(child), new_parent, child)
2191
return by_parent[old_parent]
2193
def _content_match(tree, entry, file_id, kind, target_path):
2194
if entry.kind != kind:
2196
if entry.kind == "directory":
2198
if entry.kind == "file":
2199
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
2201
elif entry.kind == "symlink":
2202
if tree.get_symlink_target(file_id) == os.readlink(target_path):
2207
def resolve_checkout(tt, conflicts, divert):
2208
new_conflicts = set()
2209
for c_type, conflict in ((c[0], c) for c in conflicts):
2210
# Anything but a 'duplicate' would indicate programmer error
2211
if c_type != 'duplicate':
2212
raise AssertionError(c_type)
2213
# Now figure out which is new and which is old
2214
if tt.new_contents(conflict[1]):
2215
new_file = conflict[1]
2216
old_file = conflict[2]
2218
new_file = conflict[2]
2219
old_file = conflict[1]
2221
# We should only get here if the conflict wasn't completely
2223
final_parent = tt.final_parent(old_file)
2224
if new_file in divert:
2225
new_name = tt.final_name(old_file)+'.diverted'
2226
tt.adjust_path(new_name, final_parent, new_file)
2227
new_conflicts.add((c_type, 'Diverted to',
2228
new_file, old_file))
2230
new_name = tt.final_name(old_file)+'.moved'
2231
tt.adjust_path(new_name, final_parent, old_file)
2232
new_conflicts.add((c_type, 'Moved existing file to',
2233
old_file, new_file))
2234
return new_conflicts
2237
def new_by_entry(tt, entry, parent_id, tree):
2238
"""Create a new file according to its inventory entry"""
2242
contents = tree.get_file(entry.file_id).readlines()
2243
executable = tree.is_executable(entry.file_id)
2244
return tt.new_file(name, parent_id, contents, entry.file_id,
2246
elif kind in ('directory', 'tree-reference'):
2247
trans_id = tt.new_directory(name, parent_id, entry.file_id)
2248
if kind == 'tree-reference':
2249
tt.set_tree_reference(entry.reference_revision, trans_id)
2251
elif kind == 'symlink':
2252
target = tree.get_symlink_target(entry.file_id)
2253
return tt.new_symlink(name, parent_id, target, entry.file_id)
2255
raise errors.BadFileKindError(name, kind)
2258
@deprecated_function(deprecated_in((1, 9, 0)))
2259
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
2260
"""Create new file contents according to an inventory entry.
2262
DEPRECATED. Use create_from_tree instead.
2264
if entry.kind == "file":
2266
lines = tree.get_file(entry.file_id).readlines()
2267
tt.create_file(lines, trans_id, mode_id=mode_id)
2268
elif entry.kind == "symlink":
2269
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2270
elif entry.kind == "directory":
2271
tt.create_directory(trans_id)
2274
def create_from_tree(tt, trans_id, tree, file_id, bytes=None):
2275
"""Create new file contents according to tree contents."""
2276
kind = tree.kind(file_id)
2277
if kind == 'directory':
2278
tt.create_directory(trans_id)
2279
elif kind == "file":
2281
tree_file = tree.get_file(file_id)
2283
bytes = tree_file.readlines()
2286
tt.create_file(bytes, trans_id)
2287
elif kind == "symlink":
2288
tt.create_symlink(tree.get_symlink_target(file_id), trans_id)
2290
raise AssertionError('Unknown kind %r' % kind)
2293
def create_entry_executability(tt, entry, trans_id):
2294
"""Set the executability of a trans_id according to an inventory entry"""
2295
if entry.kind == "file":
2296
tt.set_executability(entry.executable, trans_id)
2299
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2300
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2303
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2304
"""Produce a backup-style name that appears to be available"""
2308
yield "%s.~%d~" % (name, counter)
2310
for new_name in name_gen():
2311
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2315
def _entry_changes(file_id, entry, working_tree):
2316
"""Determine in which ways the inventory entry has changed.
2318
Returns booleans: has_contents, content_mod, meta_mod
2319
has_contents means there are currently contents, but they differ
2320
contents_mod means contents need to be modified
2321
meta_mod means the metadata needs to be modified
2323
cur_entry = working_tree.inventory[file_id]
2325
working_kind = working_tree.kind(file_id)
2328
has_contents = False
2331
if has_contents is True:
2332
if entry.kind != working_kind:
2333
contents_mod, meta_mod = True, False
2335
cur_entry._read_tree_state(working_tree.id2path(file_id),
2337
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2338
cur_entry._forget_tree_state()
2339
return has_contents, contents_mod, meta_mod
2342
def revert(working_tree, target_tree, filenames, backups=False,
2343
pb=DummyProgress(), change_reporter=None):
2344
"""Revert a working tree's contents to those of a target tree."""
2345
target_tree.lock_read()
2346
tt = TreeTransform(working_tree, pb)
2348
pp = ProgressPhase("Revert phase", 3, pb)
2349
conflicts, merge_modified = _prepare_revert_transform(
2350
working_tree, target_tree, tt, filenames, backups, pp)
2352
change_reporter = delta._ChangeReporter(
2353
unversioned_filter=working_tree.is_ignored)
2354
delta.report_changes(tt.iter_changes(), change_reporter)
2355
for conflict in conflicts:
2359
working_tree.set_merge_modified(merge_modified)
2361
target_tree.unlock()
2367
def _prepare_revert_transform(working_tree, target_tree, tt, filenames,
2368
backups, pp, basis_tree=None,
2369
merge_modified=None):
2371
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2373
if merge_modified is None:
2374
merge_modified = working_tree.merge_modified()
2375
merge_modified = _alter_files(working_tree, target_tree, tt,
2376
child_pb, filenames, backups,
2377
merge_modified, basis_tree)
2381
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2383
raw_conflicts = resolve_conflicts(tt, child_pb,
2384
lambda t, c: conflict_pass(t, c, target_tree))
2387
conflicts = cook_conflicts(raw_conflicts, tt)
2388
return conflicts, merge_modified
2391
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2392
backups, merge_modified, basis_tree=None):
2393
if basis_tree is not None:
2394
basis_tree.lock_read()
2395
change_list = target_tree.iter_changes(working_tree,
2396
specific_files=specific_files, pb=pb)
2397
if target_tree.get_root_id() is None:
2403
for id_num, (file_id, path, changed_content, versioned, parent, name,
2404
kind, executable) in enumerate(change_list):
2405
if skip_root and file_id[0] is not None and parent[0] is None:
2407
trans_id = tt.trans_id_file_id(file_id)
2410
keep_content = False
2411
if kind[0] == 'file' and (backups or kind[1] is None):
2412
wt_sha1 = working_tree.get_file_sha1(file_id)
2413
if merge_modified.get(file_id) != wt_sha1:
2414
# acquire the basis tree lazily to prevent the
2415
# expense of accessing it when it's not needed ?
2416
# (Guessing, RBC, 200702)
2417
if basis_tree is None:
2418
basis_tree = working_tree.basis_tree()
2419
basis_tree.lock_read()
2420
if file_id in basis_tree:
2421
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2423
elif kind[1] is None and not versioned[1]:
2425
if kind[0] is not None:
2426
if not keep_content:
2427
tt.delete_contents(trans_id)
2428
elif kind[1] is not None:
2429
parent_trans_id = tt.trans_id_file_id(parent[0])
2430
by_parent = tt.by_parent()
2431
backup_name = _get_backup_name(name[0], by_parent,
2432
parent_trans_id, tt)
2433
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2434
new_trans_id = tt.create_path(name[0], parent_trans_id)
2435
if versioned == (True, True):
2436
tt.unversion_file(trans_id)
2437
tt.version_file(file_id, new_trans_id)
2438
# New contents should have the same unix perms as old
2441
trans_id = new_trans_id
2442
if kind[1] in ('directory', 'tree-reference'):
2443
tt.create_directory(trans_id)
2444
if kind[1] == 'tree-reference':
2445
revision = target_tree.get_reference_revision(file_id,
2447
tt.set_tree_reference(revision, trans_id)
2448
elif kind[1] == 'symlink':
2449
tt.create_symlink(target_tree.get_symlink_target(file_id),
2451
elif kind[1] == 'file':
2452
deferred_files.append((file_id, (trans_id, mode_id)))
2453
if basis_tree is None:
2454
basis_tree = working_tree.basis_tree()
2455
basis_tree.lock_read()
2456
new_sha1 = target_tree.get_file_sha1(file_id)
2457
if (file_id in basis_tree and new_sha1 ==
2458
basis_tree.get_file_sha1(file_id)):
2459
if file_id in merge_modified:
2460
del merge_modified[file_id]
2462
merge_modified[file_id] = new_sha1
2464
# preserve the execute bit when backing up
2465
if keep_content and executable[0] == executable[1]:
2466
tt.set_executability(executable[1], trans_id)
2467
elif kind[1] is not None:
2468
raise AssertionError(kind[1])
2469
if versioned == (False, True):
2470
tt.version_file(file_id, trans_id)
2471
if versioned == (True, False):
2472
tt.unversion_file(trans_id)
2473
if (name[1] is not None and
2474
(name[0] != name[1] or parent[0] != parent[1])):
2475
if name[1] == '' and parent[1] is None:
2476
parent_trans = ROOT_PARENT
2478
parent_trans = tt.trans_id_file_id(parent[1])
2479
tt.adjust_path(name[1], parent_trans, trans_id)
2480
if executable[0] != executable[1] and kind[1] == "file":
2481
tt.set_executability(executable[1], trans_id)
2482
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2484
tt.create_file(bytes, trans_id, mode_id)
2486
if basis_tree is not None:
2488
return merge_modified
2491
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2492
"""Make many conflict-resolution attempts, but die if they fail"""
2493
if pass_func is None:
2494
pass_func = conflict_pass
2495
new_conflicts = set()
2498
pb.update('Resolution pass', n+1, 10)
2499
conflicts = tt.find_conflicts()
2500
if len(conflicts) == 0:
2501
return new_conflicts
2502
new_conflicts.update(pass_func(tt, conflicts))
2503
raise MalformedTransform(conflicts=conflicts)
2508
def conflict_pass(tt, conflicts, path_tree=None):
2509
"""Resolve some classes of conflicts.
2511
:param tt: The transform to resolve conflicts in
2512
:param conflicts: The conflicts to resolve
2513
:param path_tree: A Tree to get supplemental paths from
2515
new_conflicts = set()
2516
for c_type, conflict in ((c[0], c) for c in conflicts):
2517
if c_type == 'duplicate id':
2518
tt.unversion_file(conflict[1])
2519
new_conflicts.add((c_type, 'Unversioned existing file',
2520
conflict[1], conflict[2], ))
2521
elif c_type == 'duplicate':
2522
# files that were renamed take precedence
2523
final_parent = tt.final_parent(conflict[1])
2524
if tt.path_changed(conflict[1]):
2525
existing_file, new_file = conflict[2], conflict[1]
2527
existing_file, new_file = conflict[1], conflict[2]
2528
new_name = tt.final_name(existing_file)+'.moved'
2529
tt.adjust_path(new_name, final_parent, existing_file)
2530
new_conflicts.add((c_type, 'Moved existing file to',
2531
existing_file, new_file))
2532
elif c_type == 'parent loop':
2533
# break the loop by undoing one of the ops that caused the loop
2535
while not tt.path_changed(cur):
2536
cur = tt.final_parent(cur)
2537
new_conflicts.add((c_type, 'Cancelled move', cur,
2538
tt.final_parent(cur),))
2539
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2541
elif c_type == 'missing parent':
2542
trans_id = conflict[1]
2544
tt.cancel_deletion(trans_id)
2545
new_conflicts.add(('deleting parent', 'Not deleting',
2550
tt.final_name(trans_id)
2552
if path_tree is not None:
2553
file_id = tt.final_file_id(trans_id)
2555
file_id = tt.inactive_file_id(trans_id)
2556
entry = path_tree.inventory[file_id]
2557
# special-case the other tree root (move its
2558
# children to current root)
2559
if entry.parent_id is None:
2561
moved = _reparent_transform_children(
2562
tt, trans_id, tt.root)
2564
new_conflicts.add((c_type, 'Moved to root',
2567
parent_trans_id = tt.trans_id_file_id(
2569
tt.adjust_path(entry.name, parent_trans_id,
2572
tt.create_directory(trans_id)
2573
new_conflicts.add((c_type, 'Created directory', trans_id))
2574
elif c_type == 'unversioned parent':
2575
file_id = tt.inactive_file_id(conflict[1])
2576
# special-case the other tree root (move its children instead)
2577
if path_tree and file_id in path_tree:
2578
if path_tree.inventory[file_id].parent_id is None:
2580
tt.version_file(file_id, conflict[1])
2581
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2582
elif c_type == 'non-directory parent':
2583
parent_id = conflict[1]
2584
parent_parent = tt.final_parent(parent_id)
2585
parent_name = tt.final_name(parent_id)
2586
parent_file_id = tt.final_file_id(parent_id)
2587
new_parent_id = tt.new_directory(parent_name + '.new',
2588
parent_parent, parent_file_id)
2589
_reparent_transform_children(tt, parent_id, new_parent_id)
2590
if parent_file_id is not None:
2591
tt.unversion_file(parent_id)
2592
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2593
elif c_type == 'versioning no contents':
2594
tt.cancel_versioning(conflict[1])
2595
return new_conflicts
2598
def cook_conflicts(raw_conflicts, tt):
2599
"""Generate a list of cooked conflicts, sorted by file path"""
2600
from bzrlib.conflicts import Conflict
2601
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2602
return sorted(conflict_iter, key=Conflict.sort_key)
2605
def iter_cook_conflicts(raw_conflicts, tt):
2606
from bzrlib.conflicts import Conflict
2608
for conflict in raw_conflicts:
2609
c_type = conflict[0]
2610
action = conflict[1]
2611
modified_path = fp.get_path(conflict[2])
2612
modified_id = tt.final_file_id(conflict[2])
2613
if len(conflict) == 3:
2614
yield Conflict.factory(c_type, action=action, path=modified_path,
2615
file_id=modified_id)
2618
conflicting_path = fp.get_path(conflict[3])
2619
conflicting_id = tt.final_file_id(conflict[3])
2620
yield Conflict.factory(c_type, action=action, path=modified_path,
2621
file_id=modified_id,
2622
conflict_path=conflicting_path,
2623
conflict_file_id=conflicting_id)
2626
class _FileMover(object):
2627
"""Moves and deletes files for TreeTransform, tracking operations"""
2630
self.past_renames = []
2631
self.pending_deletions = []
2633
def rename(self, from_, to):
2634
"""Rename a file from one path to another. Functions like os.rename"""
2636
os.rename(from_, to)
2638
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2639
raise errors.FileExists(to, str(e))
2641
self.past_renames.append((from_, to))
2643
def pre_delete(self, from_, to):
2644
"""Rename a file out of the way and mark it for deletion.
2646
Unlike os.unlink, this works equally well for files and directories.
2647
:param from_: The current file path
2648
:param to: A temporary path for the file
2650
self.rename(from_, to)
2651
self.pending_deletions.append(to)
2654
"""Reverse all renames that have been performed"""
2655
for from_, to in reversed(self.past_renames):
2656
os.rename(to, from_)
2657
# after rollback, don't reuse _FileMover
2659
pending_deletions = None
2661
def apply_deletions(self):
2662
"""Apply all marked deletions"""
2663
for path in self.pending_deletions:
2665
# after apply_deletions, don't reuse _FileMover
2667
pending_deletions = None
added
removed
bzrlib/transform.py
