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
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
31
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
32
ReusingTransform, NotVersionedError, CantMoveRoot,
33
ExistingLimbo, ImmortalLimbo, NoFinalPath,
35
from bzrlib.inventory import InventoryEntry
36
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
37
delete_any, has_symlinks)
38
from bzrlib.progress import DummyProgress, ProgressPhase
39
from bzrlib.symbol_versioning import (
44
from bzrlib.trace import mutter, warning
45
from bzrlib import tree
47
import bzrlib.urlutils as urlutils
50
ROOT_PARENT = "root-parent"
53
def unique_add(map, key, value):
55
raise DuplicateKey(key=key)
59
class _TransformResults(object):
60
def __init__(self, modified_paths, rename_count):
62
self.modified_paths = modified_paths
63
self.rename_count = rename_count
66
class TreeTransformBase(object):
67
"""The base class for TreeTransform and TreeTransformBase"""
69
def __init__(self, tree, limbodir, pb=DummyProgress(),
73
:param tree: The tree that will be transformed, but not necessarily
75
:param limbodir: A directory where new files can be stored until
76
they are installed in their proper places
77
:param pb: A ProgressBar indicating how much progress is being made
78
:param case_sensitive: If True, the target of the transform is
79
case sensitive, not just case preserving.
83
self._limbodir = limbodir
84
self._deletiondir = None
86
# mapping of trans_id -> new basename
88
# mapping of trans_id -> new parent trans_id
90
# mapping of trans_id with new contents -> new file_kind
91
self._new_contents = {}
92
# A mapping of transform ids to their limbo filename
93
self._limbo_files = {}
94
# A mapping of transform ids to a set of the transform ids of children
95
# that their limbo directory has
96
self._limbo_children = {}
97
# Map transform ids to maps of child filename to child transform id
98
self._limbo_children_names = {}
99
# List of transform ids that need to be renamed from limbo into place
100
self._needs_rename = set()
101
# Set of trans_ids whose contents will be removed
102
self._removed_contents = set()
103
# Mapping of trans_id -> new execute-bit value
104
self._new_executability = {}
105
# Mapping of trans_id -> new tree-reference value
106
self._new_reference_revision = {}
107
# Mapping of trans_id -> new file_id
109
# Mapping of old file-id -> trans_id
110
self._non_present_ids = {}
111
# Mapping of new file_id -> trans_id
113
# Set of file_ids that will be removed
114
self._removed_id = set()
115
# Mapping of path in old tree -> trans_id
116
self._tree_path_ids = {}
117
# Mapping trans_id -> path in old tree
118
self._tree_id_paths = {}
119
# Cache of realpath results, to speed up canonical_path
121
# Cache of relpath results, to speed up canonical_path
123
# The trans_id that will be used as the tree root
124
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
125
# Indictor of whether the transform has been applied
129
# Whether the target is case sensitive
130
self._case_sensitive_target = case_sensitive
131
# A counter of how many files have been renamed
132
self.rename_count = 0
134
def __get_root(self):
135
return self._new_root
137
root = property(__get_root)
140
"""Release the working tree lock, if held, clean up limbo dir.
142
This is required if apply has not been invoked, but can be invoked
145
if self._tree is None:
148
entries = [(self._limbo_name(t), t, k) for t, k in
149
self._new_contents.iteritems()]
150
entries.sort(reverse=True)
151
for path, trans_id, kind in entries:
152
if kind == "directory":
157
os.rmdir(self._limbodir)
159
# We don't especially care *why* the dir is immortal.
160
raise ImmortalLimbo(self._limbodir)
162
if self._deletiondir is not None:
163
os.rmdir(self._deletiondir)
165
raise errors.ImmortalPendingDeletion(self._deletiondir)
170
def _assign_id(self):
171
"""Produce a new tranform id"""
172
new_id = "new-%s" % self._id_number
176
def create_path(self, name, parent):
177
"""Assign a transaction id to a new path"""
178
trans_id = self._assign_id()
179
unique_add(self._new_name, trans_id, name)
180
unique_add(self._new_parent, trans_id, parent)
183
def adjust_path(self, name, parent, trans_id):
184
"""Change the path that is assigned to a transaction id."""
185
if trans_id == self._new_root:
187
previous_parent = self._new_parent.get(trans_id)
188
previous_name = self._new_name.get(trans_id)
189
self._new_name[trans_id] = name
190
self._new_parent[trans_id] = parent
191
if (trans_id in self._limbo_files and
192
trans_id not in self._needs_rename):
193
self._rename_in_limbo([trans_id])
194
self._limbo_children[previous_parent].remove(trans_id)
195
del self._limbo_children_names[previous_parent][previous_name]
197
def _rename_in_limbo(self, trans_ids):
198
"""Fix limbo names so that the right final path is produced.
200
This means we outsmarted ourselves-- we tried to avoid renaming
201
these files later by creating them with their final names in their
202
final parents. But now the previous name or parent is no longer
203
suitable, so we have to rename them.
205
Even for trans_ids that have no new contents, we must remove their
206
entries from _limbo_files, because they are now stale.
208
for trans_id in trans_ids:
209
old_path = self._limbo_files.pop(trans_id)
210
if trans_id not in self._new_contents:
212
new_path = self._limbo_name(trans_id)
213
os.rename(old_path, new_path)
215
def adjust_root_path(self, name, parent):
216
"""Emulate moving the root by moving all children, instead.
218
We do this by undoing the association of root's transaction id with the
219
current tree. This allows us to create a new directory with that
220
transaction id. We unversion the root directory and version the
221
physically new directory, and hope someone versions the tree root
224
old_root = self._new_root
225
old_root_file_id = self.final_file_id(old_root)
226
# force moving all children of root
227
for child_id in self.iter_tree_children(old_root):
228
if child_id != parent:
229
self.adjust_path(self.final_name(child_id),
230
self.final_parent(child_id), child_id)
231
file_id = self.final_file_id(child_id)
232
if file_id is not None:
233
self.unversion_file(child_id)
234
self.version_file(file_id, child_id)
236
# the physical root needs a new transaction id
237
self._tree_path_ids.pop("")
238
self._tree_id_paths.pop(old_root)
239
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
240
if parent == old_root:
241
parent = self._new_root
242
self.adjust_path(name, parent, old_root)
243
self.create_directory(old_root)
244
self.version_file(old_root_file_id, old_root)
245
self.unversion_file(self._new_root)
247
def trans_id_tree_file_id(self, inventory_id):
248
"""Determine the transaction id of a working tree file.
250
This reflects only files that already exist, not ones that will be
251
added by transactions.
253
path = self._tree.id2path(inventory_id)
254
return self.trans_id_tree_path(path)
256
def trans_id_file_id(self, file_id):
257
"""Determine or set the transaction id associated with a file ID.
258
A new id is only created for file_ids that were never present. If
259
a transaction has been unversioned, it is deliberately still returned.
260
(this will likely lead to an unversioned parent conflict.)
262
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
263
return self._r_new_id[file_id]
264
elif file_id in self._tree.inventory:
265
return self.trans_id_tree_file_id(file_id)
266
elif file_id in self._non_present_ids:
267
return self._non_present_ids[file_id]
269
trans_id = self._assign_id()
270
self._non_present_ids[file_id] = trans_id
273
def canonical_path(self, path):
274
"""Get the canonical tree-relative path"""
275
# don't follow final symlinks
276
abs = self._tree.abspath(path)
277
if abs in self._relpaths:
278
return self._relpaths[abs]
279
dirname, basename = os.path.split(abs)
280
if dirname not in self._realpaths:
281
self._realpaths[dirname] = os.path.realpath(dirname)
282
dirname = self._realpaths[dirname]
283
abs = pathjoin(dirname, basename)
284
if dirname in self._relpaths:
285
relpath = pathjoin(self._relpaths[dirname], basename)
286
relpath = relpath.rstrip('/\\')
288
relpath = self._tree.relpath(abs)
289
self._relpaths[abs] = relpath
292
def trans_id_tree_path(self, path):
293
"""Determine (and maybe set) the transaction ID for a tree path."""
294
path = self.canonical_path(path)
295
if path not in self._tree_path_ids:
296
self._tree_path_ids[path] = self._assign_id()
297
self._tree_id_paths[self._tree_path_ids[path]] = path
298
return self._tree_path_ids[path]
300
def get_tree_parent(self, trans_id):
301
"""Determine id of the parent in the tree."""
302
path = self._tree_id_paths[trans_id]
305
return self.trans_id_tree_path(os.path.dirname(path))
307
def create_file(self, contents, trans_id, mode_id=None):
308
"""Schedule creation of a new file.
312
Contents is an iterator of strings, all of which will be written
313
to the target destination.
315
New file takes the permissions of any existing file with that id,
316
unless mode_id is specified.
318
name = self._limbo_name(trans_id)
322
unique_add(self._new_contents, trans_id, 'file')
324
# Clean up the file, it never got registered so
325
# TreeTransform.finalize() won't clean it up.
330
f.writelines(contents)
333
self._set_mode(trans_id, mode_id, S_ISREG)
335
def _set_mode(self, trans_id, mode_id, typefunc):
336
"""Set the mode of new file contents.
337
The mode_id is the existing file to get the mode from (often the same
338
as trans_id). The operation is only performed if there's a mode match
339
according to typefunc.
344
old_path = self._tree_id_paths[mode_id]
348
mode = os.stat(self._tree.abspath(old_path)).st_mode
350
if e.errno == errno.ENOENT:
355
os.chmod(self._limbo_name(trans_id), mode)
357
def create_hardlink(self, path, trans_id):
358
"""Schedule creation of a hard link"""
359
name = self._limbo_name(trans_id)
363
if e.errno != errno.EPERM:
365
raise errors.HardLinkNotSupported(path)
367
unique_add(self._new_contents, trans_id, 'file')
369
# Clean up the file, it never got registered so
370
# TreeTransform.finalize() won't clean it up.
374
def create_directory(self, trans_id):
375
"""Schedule creation of a new directory.
377
See also new_directory.
379
os.mkdir(self._limbo_name(trans_id))
380
unique_add(self._new_contents, trans_id, 'directory')
382
def create_symlink(self, target, trans_id):
383
"""Schedule creation of a new symbolic link.
385
target is a bytestring.
386
See also new_symlink.
389
os.symlink(target, self._limbo_name(trans_id))
390
unique_add(self._new_contents, trans_id, 'symlink')
393
path = FinalPaths(self).get_path(trans_id)
396
raise UnableCreateSymlink(path=path)
398
def cancel_creation(self, trans_id):
399
"""Cancel the creation of new file contents."""
400
del self._new_contents[trans_id]
401
children = self._limbo_children.get(trans_id)
402
# if this is a limbo directory with children, move them before removing
404
if children is not None:
405
self._rename_in_limbo(children)
406
del self._limbo_children[trans_id]
407
del self._limbo_children_names[trans_id]
408
delete_any(self._limbo_name(trans_id))
410
def delete_contents(self, trans_id):
411
"""Schedule the contents of a path entry for deletion"""
412
self.tree_kind(trans_id)
413
self._removed_contents.add(trans_id)
415
def cancel_deletion(self, trans_id):
416
"""Cancel a scheduled deletion"""
417
self._removed_contents.remove(trans_id)
419
def unversion_file(self, trans_id):
420
"""Schedule a path entry to become unversioned"""
421
self._removed_id.add(trans_id)
423
def delete_versioned(self, trans_id):
424
"""Delete and unversion a versioned file"""
425
self.delete_contents(trans_id)
426
self.unversion_file(trans_id)
428
def set_executability(self, executability, trans_id):
429
"""Schedule setting of the 'execute' bit
430
To unschedule, set to None
432
if executability is None:
433
del self._new_executability[trans_id]
435
unique_add(self._new_executability, trans_id, executability)
437
def set_tree_reference(self, revision_id, trans_id):
438
"""Set the reference associated with a directory"""
439
unique_add(self._new_reference_revision, trans_id, revision_id)
441
def version_file(self, file_id, trans_id):
442
"""Schedule a file to become versioned."""
445
unique_add(self._new_id, trans_id, file_id)
446
unique_add(self._r_new_id, file_id, trans_id)
448
def cancel_versioning(self, trans_id):
449
"""Undo a previous versioning of a file"""
450
file_id = self._new_id[trans_id]
451
del self._new_id[trans_id]
452
del self._r_new_id[file_id]
455
"""Determine the paths of all new and changed files"""
457
fp = FinalPaths(self)
458
for id_set in (self._new_name, self._new_parent, self._new_contents,
459
self._new_id, self._new_executability):
460
new_ids.update(id_set)
461
new_paths = [(fp.get_path(t), t) for t in new_ids]
465
def tree_kind(self, trans_id):
466
"""Determine the file kind in the working tree.
468
Raises NoSuchFile if the file does not exist
470
path = self._tree_id_paths.get(trans_id)
472
raise NoSuchFile(None)
474
return file_kind(self._tree.abspath(path))
476
if e.errno != errno.ENOENT:
479
raise NoSuchFile(path)
481
def final_kind(self, trans_id):
482
"""Determine the final file kind, after any changes applied.
484
Raises NoSuchFile if the file does not exist/has no contents.
485
(It is conceivable that a path would be created without the
486
corresponding contents insertion command)
488
if trans_id in self._new_contents:
489
return self._new_contents[trans_id]
490
elif trans_id in self._removed_contents:
491
raise NoSuchFile(None)
493
return self.tree_kind(trans_id)
495
def tree_file_id(self, trans_id):
496
"""Determine the file id associated with the trans_id in the tree"""
498
path = self._tree_id_paths[trans_id]
500
# the file is a new, unversioned file, or invalid trans_id
502
# the file is old; the old id is still valid
503
if self._new_root == trans_id:
504
return self._tree.get_root_id()
505
return self._tree.inventory.path2id(path)
507
def final_file_id(self, trans_id):
508
"""Determine the file id after any changes are applied, or None.
510
None indicates that the file will not be versioned after changes are
514
return self._new_id[trans_id]
516
if trans_id in self._removed_id:
518
return self.tree_file_id(trans_id)
520
def inactive_file_id(self, trans_id):
521
"""Return the inactive file_id associated with a transaction id.
522
That is, the one in the tree or in non_present_ids.
523
The file_id may actually be active, too.
525
file_id = self.tree_file_id(trans_id)
526
if file_id is not None:
528
for key, value in self._non_present_ids.iteritems():
529
if value == trans_id:
532
def final_parent(self, trans_id):
533
"""Determine the parent file_id, after any changes are applied.
535
ROOT_PARENT is returned for the tree root.
538
return self._new_parent[trans_id]
540
return self.get_tree_parent(trans_id)
542
def final_name(self, trans_id):
543
"""Determine the final filename, after all changes are applied."""
545
return self._new_name[trans_id]
548
return os.path.basename(self._tree_id_paths[trans_id])
550
raise NoFinalPath(trans_id, self)
553
"""Return a map of parent: children for known parents.
555
Only new paths and parents of tree files with assigned ids are used.
558
items = list(self._new_parent.iteritems())
559
items.extend((t, self.final_parent(t)) for t in
560
self._tree_id_paths.keys())
561
for trans_id, parent_id in items:
562
if parent_id not in by_parent:
563
by_parent[parent_id] = set()
564
by_parent[parent_id].add(trans_id)
567
def path_changed(self, trans_id):
568
"""Return True if a trans_id's path has changed."""
569
return (trans_id in self._new_name) or (trans_id in self._new_parent)
571
def new_contents(self, trans_id):
572
return (trans_id in self._new_contents)
574
def find_conflicts(self):
575
"""Find any violations of inventory or filesystem invariants"""
576
if self._done is True:
577
raise ReusingTransform()
579
# ensure all children of all existent parents are known
580
# all children of non-existent parents are known, by definition.
581
self._add_tree_children()
582
by_parent = self.by_parent()
583
conflicts.extend(self._unversioned_parents(by_parent))
584
conflicts.extend(self._parent_loops())
585
conflicts.extend(self._duplicate_entries(by_parent))
586
conflicts.extend(self._duplicate_ids())
587
conflicts.extend(self._parent_type_conflicts(by_parent))
588
conflicts.extend(self._improper_versioning())
589
conflicts.extend(self._executability_conflicts())
590
conflicts.extend(self._overwrite_conflicts())
593
def _add_tree_children(self):
594
"""Add all the children of all active parents to the known paths.
596
Active parents are those which gain children, and those which are
597
removed. This is a necessary first step in detecting conflicts.
599
parents = self.by_parent().keys()
600
parents.extend([t for t in self._removed_contents if
601
self.tree_kind(t) == 'directory'])
602
for trans_id in self._removed_id:
603
file_id = self.tree_file_id(trans_id)
604
if file_id is not None:
605
if self._tree.inventory[file_id].kind == 'directory':
606
parents.append(trans_id)
607
elif self.tree_kind(trans_id) == 'directory':
608
parents.append(trans_id)
610
for parent_id in parents:
611
# ensure that all children are registered with the transaction
612
list(self.iter_tree_children(parent_id))
614
def iter_tree_children(self, parent_id):
615
"""Iterate through the entry's tree children, if any"""
617
path = self._tree_id_paths[parent_id]
621
children = os.listdir(self._tree.abspath(path))
623
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
627
for child in children:
628
childpath = joinpath(path, child)
629
if self._tree.is_control_filename(childpath):
631
yield self.trans_id_tree_path(childpath)
633
def has_named_child(self, by_parent, parent_id, name):
635
children = by_parent[parent_id]
638
for child in children:
639
if self.final_name(child) == name:
642
path = self._tree_id_paths[parent_id]
645
childpath = joinpath(path, name)
646
child_id = self._tree_path_ids.get(childpath)
648
return lexists(self._tree.abspath(childpath))
650
if self.final_parent(child_id) != parent_id:
652
if child_id in self._removed_contents:
653
# XXX What about dangling file-ids?
658
def _parent_loops(self):
659
"""No entry should be its own ancestor"""
661
for trans_id in self._new_parent:
664
while parent_id is not ROOT_PARENT:
667
parent_id = self.final_parent(parent_id)
670
if parent_id == trans_id:
671
conflicts.append(('parent loop', trans_id))
672
if parent_id in seen:
676
def _unversioned_parents(self, by_parent):
677
"""If parent directories are versioned, children must be versioned."""
679
for parent_id, children in by_parent.iteritems():
680
if parent_id is ROOT_PARENT:
682
if self.final_file_id(parent_id) is not None:
684
for child_id in children:
685
if self.final_file_id(child_id) is not None:
686
conflicts.append(('unversioned parent', parent_id))
690
def _improper_versioning(self):
691
"""Cannot version a file with no contents, or a bad type.
693
However, existing entries with no contents are okay.
696
for trans_id in self._new_id.iterkeys():
698
kind = self.final_kind(trans_id)
700
conflicts.append(('versioning no contents', trans_id))
702
if not InventoryEntry.versionable_kind(kind):
703
conflicts.append(('versioning bad kind', trans_id, kind))
706
def _executability_conflicts(self):
707
"""Check for bad executability changes.
709
Only versioned files may have their executability set, because
710
1. only versioned entries can have executability under windows
711
2. only files can be executable. (The execute bit on a directory
712
does not indicate searchability)
715
for trans_id in self._new_executability:
716
if self.final_file_id(trans_id) is None:
717
conflicts.append(('unversioned executability', trans_id))
720
non_file = self.final_kind(trans_id) != "file"
724
conflicts.append(('non-file executability', trans_id))
727
def _overwrite_conflicts(self):
728
"""Check for overwrites (not permitted on Win32)"""
730
for trans_id in self._new_contents:
732
self.tree_kind(trans_id)
735
if trans_id not in self._removed_contents:
736
conflicts.append(('overwrite', trans_id,
737
self.final_name(trans_id)))
740
def _duplicate_entries(self, by_parent):
741
"""No directory may have two entries with the same name."""
743
if (self._new_name, self._new_parent) == ({}, {}):
745
for children in by_parent.itervalues():
746
name_ids = [(self.final_name(t), t) for t in children]
747
if not self._case_sensitive_target:
748
name_ids = [(n.lower(), t) for n, t in name_ids]
752
for name, trans_id in name_ids:
754
kind = self.final_kind(trans_id)
757
file_id = self.final_file_id(trans_id)
758
if kind is None and file_id is None:
760
if name == last_name:
761
conflicts.append(('duplicate', last_trans_id, trans_id,
764
last_trans_id = trans_id
767
def _duplicate_ids(self):
768
"""Each inventory id may only be used once"""
770
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
772
all_ids = self._tree.all_file_ids()
773
active_tree_ids = all_ids.difference(removed_tree_ids)
774
for trans_id, file_id in self._new_id.iteritems():
775
if file_id in active_tree_ids:
776
old_trans_id = self.trans_id_tree_file_id(file_id)
777
conflicts.append(('duplicate id', old_trans_id, trans_id))
780
def _parent_type_conflicts(self, by_parent):
781
"""parents must have directory 'contents'."""
783
for parent_id, children in by_parent.iteritems():
784
if parent_id is ROOT_PARENT:
786
if not self._any_contents(children):
788
for child in children:
790
self.final_kind(child)
794
kind = self.final_kind(parent_id)
798
conflicts.append(('missing parent', parent_id))
799
elif kind != "directory":
800
conflicts.append(('non-directory parent', parent_id))
803
def _any_contents(self, trans_ids):
804
"""Return true if any of the trans_ids, will have contents."""
805
for trans_id in trans_ids:
807
kind = self.final_kind(trans_id)
813
def _limbo_name(self, trans_id):
814
"""Generate the limbo name of a file"""
815
limbo_name = self._limbo_files.get(trans_id)
816
if limbo_name is not None:
818
parent = self._new_parent.get(trans_id)
819
# if the parent directory is already in limbo (e.g. when building a
820
# tree), choose a limbo name inside the parent, to reduce further
822
use_direct_path = False
823
if self._new_contents.get(parent) == 'directory':
824
filename = self._new_name.get(trans_id)
825
if filename is not None:
826
if parent not in self._limbo_children:
827
self._limbo_children[parent] = set()
828
self._limbo_children_names[parent] = {}
829
use_direct_path = True
830
# the direct path can only be used if no other file has
831
# already taken this pathname, i.e. if the name is unused, or
832
# if it is already associated with this trans_id.
833
elif self._case_sensitive_target:
834
if (self._limbo_children_names[parent].get(filename)
835
in (trans_id, None)):
836
use_direct_path = True
838
for l_filename, l_trans_id in\
839
self._limbo_children_names[parent].iteritems():
840
if l_trans_id == trans_id:
842
if l_filename.lower() == filename.lower():
845
use_direct_path = True
848
limbo_name = pathjoin(self._limbo_files[parent], filename)
849
self._limbo_children[parent].add(trans_id)
850
self._limbo_children_names[parent][filename] = trans_id
852
limbo_name = pathjoin(self._limbodir, trans_id)
853
self._needs_rename.add(trans_id)
854
self._limbo_files[trans_id] = limbo_name
857
def _set_executability(self, path, entry, trans_id):
858
"""Set the executability of versioned files """
859
new_executability = self._new_executability[trans_id]
860
entry.executable = new_executability
861
if supports_executable():
862
abspath = self._tree.abspath(path)
863
current_mode = os.stat(abspath).st_mode
864
if new_executability:
867
to_mode = current_mode | (0100 & ~umask)
868
# Enable x-bit for others only if they can read it.
869
if current_mode & 0004:
870
to_mode |= 0001 & ~umask
871
if current_mode & 0040:
872
to_mode |= 0010 & ~umask
874
to_mode = current_mode & ~0111
875
os.chmod(abspath, to_mode)
877
def _new_entry(self, name, parent_id, file_id):
878
"""Helper function to create a new filesystem entry."""
879
trans_id = self.create_path(name, parent_id)
880
if file_id is not None:
881
self.version_file(file_id, trans_id)
884
def new_file(self, name, parent_id, contents, file_id=None,
886
"""Convenience method to create files.
888
name is the name of the file to create.
889
parent_id is the transaction id of the parent directory of the file.
890
contents is an iterator of bytestrings, which will be used to produce
892
:param file_id: The inventory ID of the file, if it is to be versioned.
893
:param executable: Only valid when a file_id has been supplied.
895
trans_id = self._new_entry(name, parent_id, file_id)
896
# TODO: rather than scheduling a set_executable call,
897
# have create_file create the file with the right mode.
898
self.create_file(contents, trans_id)
899
if executable is not None:
900
self.set_executability(executable, trans_id)
903
def new_directory(self, name, parent_id, file_id=None):
904
"""Convenience method to create directories.
906
name is the name of the directory to create.
907
parent_id is the transaction id of the parent directory of the
909
file_id is the inventory ID of the directory, if it is to be versioned.
911
trans_id = self._new_entry(name, parent_id, file_id)
912
self.create_directory(trans_id)
915
def new_symlink(self, name, parent_id, target, file_id=None):
916
"""Convenience method to create symbolic link.
918
name is the name of the symlink to create.
919
parent_id is the transaction id of the parent directory of the symlink.
920
target is a bytestring of the target of the symlink.
921
file_id is the inventory ID of the file, if it is to be versioned.
923
trans_id = self._new_entry(name, parent_id, file_id)
924
self.create_symlink(target, trans_id)
927
def _affected_ids(self):
928
"""Return the set of transform ids affected by the transform"""
929
trans_ids = set(self._removed_id)
930
trans_ids.update(self._new_id.keys())
931
trans_ids.update(self._removed_contents)
932
trans_ids.update(self._new_contents.keys())
933
trans_ids.update(self._new_executability.keys())
934
trans_ids.update(self._new_name.keys())
935
trans_ids.update(self._new_parent.keys())
938
def _get_file_id_maps(self):
939
"""Return mapping of file_ids to trans_ids in the to and from states"""
940
trans_ids = self._affected_ids()
943
# Build up two dicts: trans_ids associated with file ids in the
944
# FROM state, vs the TO state.
945
for trans_id in trans_ids:
946
from_file_id = self.tree_file_id(trans_id)
947
if from_file_id is not None:
948
from_trans_ids[from_file_id] = trans_id
949
to_file_id = self.final_file_id(trans_id)
950
if to_file_id is not None:
951
to_trans_ids[to_file_id] = trans_id
952
return from_trans_ids, to_trans_ids
954
def _from_file_data(self, from_trans_id, from_versioned, file_id):
955
"""Get data about a file in the from (tree) state
957
Return a (name, parent, kind, executable) tuple
959
from_path = self._tree_id_paths.get(from_trans_id)
961
# get data from working tree if versioned
962
from_entry = self._tree.inventory[file_id]
963
from_name = from_entry.name
964
from_parent = from_entry.parent_id
967
if from_path is None:
968
# File does not exist in FROM state
972
# File exists, but is not versioned. Have to use path-
974
from_name = os.path.basename(from_path)
975
tree_parent = self.get_tree_parent(from_trans_id)
976
from_parent = self.tree_file_id(tree_parent)
977
if from_path is not None:
978
from_kind, from_executable, from_stats = \
979
self._tree._comparison_data(from_entry, from_path)
982
from_executable = False
983
return from_name, from_parent, from_kind, from_executable
985
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
986
"""Get data about a file in the to (target) state
988
Return a (name, parent, kind, executable) tuple
990
to_name = self.final_name(to_trans_id)
992
to_kind = self.final_kind(to_trans_id)
995
to_parent = self.final_file_id(self.final_parent(to_trans_id))
996
if to_trans_id in self._new_executability:
997
to_executable = self._new_executability[to_trans_id]
998
elif to_trans_id == from_trans_id:
999
to_executable = from_executable
1001
to_executable = False
1002
return to_name, to_parent, to_kind, to_executable
1004
def iter_changes(self):
1005
"""Produce output in the same format as Tree.iter_changes.
1007
Will produce nonsensical results if invoked while inventory/filesystem
1008
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1010
This reads the Transform, but only reproduces changes involving a
1011
file_id. Files that are not versioned in either of the FROM or TO
1012
states are not reflected.
1014
final_paths = FinalPaths(self)
1015
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1017
# Now iterate through all active file_ids
1018
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1020
from_trans_id = from_trans_ids.get(file_id)
1021
# find file ids, and determine versioning state
1022
if from_trans_id is None:
1023
from_versioned = False
1024
from_trans_id = to_trans_ids[file_id]
1026
from_versioned = True
1027
to_trans_id = to_trans_ids.get(file_id)
1028
if to_trans_id is None:
1029
to_versioned = False
1030
to_trans_id = from_trans_id
1034
from_name, from_parent, from_kind, from_executable = \
1035
self._from_file_data(from_trans_id, from_versioned, file_id)
1037
to_name, to_parent, to_kind, to_executable = \
1038
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1040
if not from_versioned:
1043
from_path = self._tree_id_paths.get(from_trans_id)
1044
if not to_versioned:
1047
to_path = final_paths.get_path(to_trans_id)
1048
if from_kind != to_kind:
1050
elif to_kind in ('file', 'symlink') and (
1051
to_trans_id != from_trans_id or
1052
to_trans_id in self._new_contents):
1054
if (not modified and from_versioned == to_versioned and
1055
from_parent==to_parent and from_name == to_name and
1056
from_executable == to_executable):
1058
results.append((file_id, (from_path, to_path), modified,
1059
(from_versioned, to_versioned),
1060
(from_parent, to_parent),
1061
(from_name, to_name),
1062
(from_kind, to_kind),
1063
(from_executable, to_executable)))
1064
return iter(sorted(results, key=lambda x:x[1]))
1066
def get_preview_tree(self):
1067
"""Return a tree representing the result of the transform.
1069
This tree only supports the subset of Tree functionality required
1070
by show_diff_trees. It must only be compared to tt._tree.
1072
return _PreviewTree(self)
1075
class TreeTransform(TreeTransformBase):
1076
"""Represent a tree transformation.
1078
This object is designed to support incremental generation of the transform,
1081
However, it gives optimum performance when parent directories are created
1082
before their contents. The transform is then able to put child files
1083
directly in their parent directory, avoiding later renames.
1085
It is easy to produce malformed transforms, but they are generally
1086
harmless. Attempting to apply a malformed transform will cause an
1087
exception to be raised before any modifications are made to the tree.
1089
Many kinds of malformed transforms can be corrected with the
1090
resolve_conflicts function. The remaining ones indicate programming error,
1091
such as trying to create a file with no path.
1093
Two sets of file creation methods are supplied. Convenience methods are:
1098
These are composed of the low-level methods:
1100
* create_file or create_directory or create_symlink
1104
Transform/Transaction ids
1105
-------------------------
1106
trans_ids are temporary ids assigned to all files involved in a transform.
1107
It's possible, even common, that not all files in the Tree have trans_ids.
1109
trans_ids are used because filenames and file_ids are not good enough
1110
identifiers; filenames change, and not all files have file_ids. File-ids
1111
are also associated with trans-ids, so that moving a file moves its
1114
trans_ids are only valid for the TreeTransform that generated them.
1118
Limbo is a temporary directory use to hold new versions of files.
1119
Files are added to limbo by create_file, create_directory, create_symlink,
1120
and their convenience variants (new_*). Files may be removed from limbo
1121
using cancel_creation. Files are renamed from limbo into their final
1122
location as part of TreeTransform.apply
1124
Limbo must be cleaned up, by either calling TreeTransform.apply or
1125
calling TreeTransform.finalize.
1127
Files are placed into limbo inside their parent directories, where
1128
possible. This reduces subsequent renames, and makes operations involving
1129
lots of files faster. This optimization is only possible if the parent
1130
directory is created *before* creating any of its children, so avoid
1131
creating children before parents, where possible.
1135
This temporary directory is used by _FileMover for storing files that are
1136
about to be deleted. In case of rollback, the files will be restored.
1137
FileMover does not delete files until it is sure that a rollback will not
1140
def __init__(self, tree, pb=DummyProgress()):
1141
"""Note: a tree_write lock is taken on the tree.
1143
Use TreeTransform.finalize() to release the lock (can be omitted if
1144
TreeTransform.apply() called).
1146
tree.lock_tree_write()
1149
control_files = tree._control_files
1150
limbodir = urlutils.local_path_from_url(
1151
control_files.controlfilename('limbo'))
1155
if e.errno == errno.EEXIST:
1156
raise ExistingLimbo(limbodir)
1157
deletiondir = urlutils.local_path_from_url(
1158
control_files.controlfilename('pending-deletion'))
1160
os.mkdir(deletiondir)
1162
if e.errno == errno.EEXIST:
1163
raise errors.ExistingPendingDeletion(deletiondir)
1168
TreeTransformBase.__init__(self, tree, limbodir, pb,
1169
tree.case_sensitive)
1170
self._deletiondir = deletiondir
1172
def apply(self, no_conflicts=False, _mover=None):
1173
"""Apply all changes to the inventory and filesystem.
1175
If filesystem or inventory conflicts are present, MalformedTransform
1178
If apply succeeds, finalize is not necessary.
1180
:param no_conflicts: if True, the caller guarantees there are no
1181
conflicts, so no check is made.
1182
:param _mover: Supply an alternate FileMover, for testing
1184
if not no_conflicts:
1185
conflicts = self.find_conflicts()
1186
if len(conflicts) != 0:
1187
raise MalformedTransform(conflicts=conflicts)
1188
inventory_delta = []
1189
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1192
mover = _FileMover()
1196
child_pb.update('Apply phase', 0, 2)
1197
self._apply_removals(inventory_delta, mover)
1198
child_pb.update('Apply phase', 1, 2)
1199
modified_paths = self._apply_insertions(inventory_delta, mover)
1204
mover.apply_deletions()
1207
self._tree.apply_inventory_delta(inventory_delta)
1210
return _TransformResults(modified_paths, self.rename_count)
1212
def _apply_removals(self, inventory_delta, mover):
1213
"""Perform tree operations that remove directory/inventory names.
1215
That is, delete files that are to be deleted, and put any files that
1216
need renaming into limbo. This must be done in strict child-to-parent
1219
tree_paths = list(self._tree_path_ids.iteritems())
1220
tree_paths.sort(reverse=True)
1221
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1223
for num, data in enumerate(tree_paths):
1224
path, trans_id = data
1225
child_pb.update('removing file', num, len(tree_paths))
1226
full_path = self._tree.abspath(path)
1227
if trans_id in self._removed_contents:
1228
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1230
elif trans_id in self._new_name or trans_id in \
1233
mover.rename(full_path, self._limbo_name(trans_id))
1235
if e.errno != errno.ENOENT:
1238
self.rename_count += 1
1239
if trans_id in self._removed_id:
1240
if trans_id == self._new_root:
1241
file_id = self._tree.get_root_id()
1243
file_id = self.tree_file_id(trans_id)
1244
# File-id isn't really being deleted, just moved
1245
if file_id in self._r_new_id:
1247
inventory_delta.append((path, None, file_id, None))
1251
def _apply_insertions(self, inventory_delta, mover):
1252
"""Perform tree operations that insert directory/inventory names.
1254
That is, create any files that need to be created, and restore from
1255
limbo any files that needed renaming. This must be done in strict
1256
parent-to-child order.
1258
new_paths = self.new_paths()
1260
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1263
for num, (path, trans_id) in enumerate(new_paths):
1265
child_pb.update('adding file', num, len(new_paths))
1266
if trans_id in self._new_contents or \
1267
self.path_changed(trans_id):
1268
full_path = self._tree.abspath(path)
1269
if trans_id in self._needs_rename:
1271
mover.rename(self._limbo_name(trans_id), full_path)
1273
# We may be renaming a dangling inventory id
1274
if e.errno != errno.ENOENT:
1277
self.rename_count += 1
1278
if trans_id in self._new_contents:
1279
modified_paths.append(full_path)
1280
completed_new.append(trans_id)
1281
file_id = self.final_file_id(trans_id)
1282
if file_id is not None and (trans_id in self._new_id or
1283
trans_id in self._new_name or trans_id in self._new_parent
1284
or trans_id in self._new_executability):
1286
kind = self.final_kind(trans_id)
1288
kind = self._tree.stored_kind(file_id)
1289
if trans_id in self._new_reference_revision:
1290
new_entry = inventory.TreeReference(
1291
self.final_file_id(trans_id),
1292
self._new_name[trans_id],
1293
self.final_file_id(self._new_parent[trans_id]),
1294
None, self._new_reference_revision[trans_id])
1296
new_entry = inventory.make_entry(kind,
1297
self.final_name(trans_id),
1298
self.final_file_id(self.final_parent(trans_id)),
1299
self.final_file_id(trans_id))
1301
old_path = self._tree.id2path(new_entry.file_id)
1302
except errors.NoSuchId:
1304
inventory_delta.append((old_path, path, new_entry.file_id,
1307
if trans_id in self._new_executability:
1308
self._set_executability(path, new_entry, trans_id)
1311
for trans_id in completed_new:
1312
del self._new_contents[trans_id]
1313
return modified_paths
1316
class TransformPreview(TreeTransformBase):
1317
"""A TreeTransform for generating preview trees.
1319
Unlike TreeTransform, this version works when the input tree is a
1320
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1321
unversioned files in the input tree.
1324
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1326
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1327
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1329
def canonical_path(self, path):
1332
def tree_kind(self, trans_id):
1333
path = self._tree_id_paths.get(trans_id)
1335
raise NoSuchFile(None)
1336
file_id = self._tree.path2id(path)
1337
return self._tree.kind(file_id)
1339
def _set_mode(self, trans_id, mode_id, typefunc):
1340
"""Set the mode of new file contents.
1341
The mode_id is the existing file to get the mode from (often the same
1342
as trans_id). The operation is only performed if there's a mode match
1343
according to typefunc.
1345
# is it ok to ignore this? probably
1348
def iter_tree_children(self, parent_id):
1349
"""Iterate through the entry's tree children, if any"""
1351
path = self._tree_id_paths[parent_id]
1354
file_id = self.tree_file_id(parent_id)
1355
for child in self._tree.inventory[file_id].children.iterkeys():
1356
childpath = joinpath(path, child)
1357
yield self.trans_id_tree_path(childpath)
1360
class _PreviewTree(object):
1361
"""Partial implementation of Tree to support show_diff_trees"""
1363
def __init__(self, transform):
1364
self._transform = transform
1366
def lock_read(self):
1367
# Perhaps in theory, this should lock the TreeTransform?
1373
def iter_changes(self, from_tree, include_unchanged=False,
1374
specific_files=None, pb=None, extra_trees=None,
1375
require_versioned=True, want_unversioned=False):
1376
"""See InterTree.iter_changes.
1378
This implementation does not support include_unchanged, specific_files,
1379
or want_unversioned. extra_trees, require_versioned, and pb are
1382
if from_tree is not self._transform._tree:
1383
raise ValueError('from_tree must be transform source tree.')
1384
if include_unchanged:
1385
raise ValueError('include_unchanged is not supported')
1386
if specific_files is not None:
1387
raise ValueError('specific_files is not supported')
1388
if want_unversioned:
1389
raise ValueError('want_unversioned is not supported')
1390
return self._transform.iter_changes()
1392
def kind(self, file_id):
1393
trans_id = self._transform.trans_id_file_id(file_id)
1394
return self._transform.final_kind(trans_id)
1396
def get_file_mtime(self, file_id, path=None):
1397
"""See Tree.get_file_mtime"""
1398
trans_id = self._transform.trans_id_file_id(file_id)
1399
name = self._transform._limbo_name(trans_id)
1400
return os.stat(name).st_mtime
1402
def get_file(self, file_id):
1403
"""See Tree.get_file"""
1404
trans_id = self._transform.trans_id_file_id(file_id)
1405
name = self._transform._limbo_name(trans_id)
1406
return open(name, 'rb')
1408
def get_symlink_target(self, file_id):
1409
"""See Tree.get_symlink_target"""
1410
trans_id = self._transform.trans_id_file_id(file_id)
1411
name = self._transform._limbo_name(trans_id)
1412
return os.readlink(name)
1414
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1415
"""See Tree.paths2ids"""
1419
def joinpath(parent, child):
1420
"""Join tree-relative paths, handling the tree root specially"""
1421
if parent is None or parent == "":
1424
return pathjoin(parent, child)
1427
class FinalPaths(object):
1428
"""Make path calculation cheap by memoizing paths.
1430
The underlying tree must not be manipulated between calls, or else
1431
the results will likely be incorrect.
1433
def __init__(self, transform):
1434
object.__init__(self)
1435
self._known_paths = {}
1436
self.transform = transform
1438
def _determine_path(self, trans_id):
1439
if trans_id == self.transform.root:
1441
name = self.transform.final_name(trans_id)
1442
parent_id = self.transform.final_parent(trans_id)
1443
if parent_id == self.transform.root:
1446
return pathjoin(self.get_path(parent_id), name)
1448
def get_path(self, trans_id):
1449
"""Find the final path associated with a trans_id"""
1450
if trans_id not in self._known_paths:
1451
self._known_paths[trans_id] = self._determine_path(trans_id)
1452
return self._known_paths[trans_id]
1455
def topology_sorted_ids(tree):
1456
"""Determine the topological order of the ids in a tree"""
1457
file_ids = list(tree)
1458
file_ids.sort(key=tree.id2path)
1462
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
1463
"""Create working tree for a branch, using a TreeTransform.
1465
This function should be used on empty trees, having a tree root at most.
1466
(see merge and revert functionality for working with existing trees)
1468
Existing files are handled like so:
1470
- Existing bzrdirs take precedence over creating new items. They are
1471
created as '%s.diverted' % name.
1472
- Otherwise, if the content on disk matches the content we are building,
1473
it is silently replaced.
1474
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1476
:param tree: The tree to convert wt into a copy of
1477
:param wt: The working tree that files will be placed into
1478
:param accelerator_tree: A tree which can be used for retrieving file
1479
contents more quickly than tree itself, i.e. a workingtree. tree
1480
will be used for cases where accelerator_tree's content is different.
1481
:param hardlink: If true, hard-link files to accelerator_tree, where
1482
possible. accelerator_tree must implement abspath, i.e. be a
1485
wt.lock_tree_write()
1489
if accelerator_tree is not None:
1490
accelerator_tree.lock_read()
1492
return _build_tree(tree, wt, accelerator_tree, hardlink)
1494
if accelerator_tree is not None:
1495
accelerator_tree.unlock()
1502
def _build_tree(tree, wt, accelerator_tree, hardlink):
1503
"""See build_tree."""
1504
for num, _unused in enumerate(wt.all_file_ids()):
1505
if num > 0: # more than just a root
1506
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1508
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1509
pp = ProgressPhase("Build phase", 2, top_pb)
1510
if tree.inventory.root is not None:
1511
# This is kind of a hack: we should be altering the root
1512
# as part of the regular tree shape diff logic.
1513
# The conditional test here is to avoid doing an
1514
# expensive operation (flush) every time the root id
1515
# is set within the tree, nor setting the root and thus
1516
# marking the tree as dirty, because we use two different
1517
# idioms here: tree interfaces and inventory interfaces.
1518
if wt.get_root_id() != tree.get_root_id():
1519
wt.set_root_id(tree.get_root_id())
1521
tt = TreeTransform(wt)
1525
file_trans_id[wt.get_root_id()] = \
1526
tt.trans_id_tree_file_id(wt.get_root_id())
1527
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1529
deferred_contents = []
1531
for num, (tree_path, entry) in \
1532
enumerate(tree.inventory.iter_entries_by_dir()):
1533
pb.update("Building tree", num - len(deferred_contents),
1534
len(tree.inventory))
1535
if entry.parent_id is None:
1538
file_id = entry.file_id
1539
target_path = wt.abspath(tree_path)
1541
kind = file_kind(target_path)
1545
if kind == "directory":
1547
bzrdir.BzrDir.open(target_path)
1548
except errors.NotBranchError:
1552
if (file_id not in divert and
1553
_content_match(tree, entry, file_id, kind,
1555
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1556
if kind == 'directory':
1558
if entry.parent_id not in file_trans_id:
1559
raise AssertionError(
1560
'entry %s parent id %r is not in file_trans_id %r'
1561
% (entry, entry.parent_id, file_trans_id))
1562
parent_id = file_trans_id[entry.parent_id]
1563
if entry.kind == 'file':
1564
# We *almost* replicate new_by_entry, so that we can defer
1565
# getting the file text, and get them all at once.
1566
trans_id = tt.create_path(entry.name, parent_id)
1567
file_trans_id[file_id] = trans_id
1568
tt.version_file(entry.file_id, trans_id)
1569
executable = tree.is_executable(entry.file_id, tree_path)
1570
if executable is not None:
1571
tt.set_executability(executable, trans_id)
1572
deferred_contents.append((entry.file_id, trans_id))
1574
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1577
new_trans_id = file_trans_id[file_id]
1578
old_parent = tt.trans_id_tree_path(tree_path)
1579
_reparent_children(tt, old_parent, new_trans_id)
1580
offset = num + 1 - len(deferred_contents)
1581
_create_files(tt, tree, deferred_contents, pb, offset,
1582
accelerator_tree, hardlink)
1586
divert_trans = set(file_trans_id[f] for f in divert)
1587
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1588
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1589
conflicts = cook_conflicts(raw_conflicts, tt)
1590
for conflict in conflicts:
1593
wt.add_conflicts(conflicts)
1594
except errors.UnsupportedOperation:
1596
result = tt.apply(no_conflicts=True)
1603
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1605
total = len(desired_files) + offset
1606
if accelerator_tree is None:
1607
new_desired_files = desired_files
1609
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1610
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1611
in iter if not (c or e[0] != e[1]))
1612
new_desired_files = []
1614
for file_id, trans_id in desired_files:
1615
accelerator_path = unchanged.get(file_id)
1616
if accelerator_path is None:
1617
new_desired_files.append((file_id, trans_id))
1619
pb.update('Adding file contents', count + offset, total)
1621
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1624
contents = accelerator_tree.get_file(file_id, accelerator_path)
1626
tt.create_file(contents, trans_id)
1631
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1632
new_desired_files)):
1633
tt.create_file(contents, trans_id)
1634
pb.update('Adding file contents', count + offset, total)
1637
def _reparent_children(tt, old_parent, new_parent):
1638
for child in tt.iter_tree_children(old_parent):
1639
tt.adjust_path(tt.final_name(child), new_parent, child)
1641
def _reparent_transform_children(tt, old_parent, new_parent):
1642
by_parent = tt.by_parent()
1643
for child in by_parent[old_parent]:
1644
tt.adjust_path(tt.final_name(child), new_parent, child)
1645
return by_parent[old_parent]
1647
def _content_match(tree, entry, file_id, kind, target_path):
1648
if entry.kind != kind:
1650
if entry.kind == "directory":
1652
if entry.kind == "file":
1653
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1655
elif entry.kind == "symlink":
1656
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1661
def resolve_checkout(tt, conflicts, divert):
1662
new_conflicts = set()
1663
for c_type, conflict in ((c[0], c) for c in conflicts):
1664
# Anything but a 'duplicate' would indicate programmer error
1665
if c_type != 'duplicate':
1666
raise AssertionError(c_type)
1667
# Now figure out which is new and which is old
1668
if tt.new_contents(conflict[1]):
1669
new_file = conflict[1]
1670
old_file = conflict[2]
1672
new_file = conflict[2]
1673
old_file = conflict[1]
1675
# We should only get here if the conflict wasn't completely
1677
final_parent = tt.final_parent(old_file)
1678
if new_file in divert:
1679
new_name = tt.final_name(old_file)+'.diverted'
1680
tt.adjust_path(new_name, final_parent, new_file)
1681
new_conflicts.add((c_type, 'Diverted to',
1682
new_file, old_file))
1684
new_name = tt.final_name(old_file)+'.moved'
1685
tt.adjust_path(new_name, final_parent, old_file)
1686
new_conflicts.add((c_type, 'Moved existing file to',
1687
old_file, new_file))
1688
return new_conflicts
1691
def new_by_entry(tt, entry, parent_id, tree):
1692
"""Create a new file according to its inventory entry"""
1696
contents = tree.get_file(entry.file_id).readlines()
1697
executable = tree.is_executable(entry.file_id)
1698
return tt.new_file(name, parent_id, contents, entry.file_id,
1700
elif kind in ('directory', 'tree-reference'):
1701
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1702
if kind == 'tree-reference':
1703
tt.set_tree_reference(entry.reference_revision, trans_id)
1705
elif kind == 'symlink':
1706
target = tree.get_symlink_target(entry.file_id)
1707
return tt.new_symlink(name, parent_id, target, entry.file_id)
1709
raise errors.BadFileKindError(name, kind)
1712
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1713
"""Create new file contents according to an inventory entry."""
1714
if entry.kind == "file":
1716
lines = tree.get_file(entry.file_id).readlines()
1717
tt.create_file(lines, trans_id, mode_id=mode_id)
1718
elif entry.kind == "symlink":
1719
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1720
elif entry.kind == "directory":
1721
tt.create_directory(trans_id)
1724
def create_entry_executability(tt, entry, trans_id):
1725
"""Set the executability of a trans_id according to an inventory entry"""
1726
if entry.kind == "file":
1727
tt.set_executability(entry.executable, trans_id)
1730
@deprecated_function(zero_fifteen)
1731
def find_interesting(working_tree, target_tree, filenames):
1732
"""Find the ids corresponding to specified filenames.
1734
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1736
working_tree.lock_read()
1738
target_tree.lock_read()
1740
return working_tree.paths2ids(filenames, [target_tree])
1742
target_tree.unlock()
1744
working_tree.unlock()
1747
@deprecated_function(zero_ninety)
1748
def change_entry(tt, file_id, working_tree, target_tree,
1749
trans_id_file_id, backups, trans_id, by_parent):
1750
"""Replace a file_id's contents with those from a target tree."""
1751
if file_id is None and target_tree is None:
1752
# skip the logic altogether in the deprecation test
1754
e_trans_id = trans_id_file_id(file_id)
1755
entry = target_tree.inventory[file_id]
1756
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1759
mode_id = e_trans_id
1762
tt.delete_contents(e_trans_id)
1764
parent_trans_id = trans_id_file_id(entry.parent_id)
1765
backup_name = get_backup_name(entry, by_parent,
1766
parent_trans_id, tt)
1767
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1768
tt.unversion_file(e_trans_id)
1769
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1770
tt.version_file(file_id, e_trans_id)
1771
trans_id[file_id] = e_trans_id
1772
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1773
create_entry_executability(tt, entry, e_trans_id)
1776
tt.set_executability(entry.executable, e_trans_id)
1777
if tt.final_name(e_trans_id) != entry.name:
1780
parent_id = tt.final_parent(e_trans_id)
1781
parent_file_id = tt.final_file_id(parent_id)
1782
if parent_file_id != entry.parent_id:
1787
parent_trans_id = trans_id_file_id(entry.parent_id)
1788
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1791
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1792
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1795
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1796
"""Produce a backup-style name that appears to be available"""
1800
yield "%s.~%d~" % (name, counter)
1802
for new_name in name_gen():
1803
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1807
def _entry_changes(file_id, entry, working_tree):
1808
"""Determine in which ways the inventory entry has changed.
1810
Returns booleans: has_contents, content_mod, meta_mod
1811
has_contents means there are currently contents, but they differ
1812
contents_mod means contents need to be modified
1813
meta_mod means the metadata needs to be modified
1815
cur_entry = working_tree.inventory[file_id]
1817
working_kind = working_tree.kind(file_id)
1820
has_contents = False
1823
if has_contents is True:
1824
if entry.kind != working_kind:
1825
contents_mod, meta_mod = True, False
1827
cur_entry._read_tree_state(working_tree.id2path(file_id),
1829
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1830
cur_entry._forget_tree_state()
1831
return has_contents, contents_mod, meta_mod
1834
def revert(working_tree, target_tree, filenames, backups=False,
1835
pb=DummyProgress(), change_reporter=None):
1836
"""Revert a working tree's contents to those of a target tree."""
1837
target_tree.lock_read()
1838
tt = TreeTransform(working_tree, pb)
1840
pp = ProgressPhase("Revert phase", 3, pb)
1842
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1844
merge_modified = _alter_files(working_tree, target_tree, tt,
1845
child_pb, filenames, backups)
1849
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1851
raw_conflicts = resolve_conflicts(tt, child_pb,
1852
lambda t, c: conflict_pass(t, c, target_tree))
1855
conflicts = cook_conflicts(raw_conflicts, tt)
1857
change_reporter = delta._ChangeReporter(
1858
unversioned_filter=working_tree.is_ignored)
1859
delta.report_changes(tt.iter_changes(), change_reporter)
1860
for conflict in conflicts:
1864
working_tree.set_merge_modified(merge_modified)
1866
target_tree.unlock()
1872
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1874
merge_modified = working_tree.merge_modified()
1875
change_list = target_tree.iter_changes(working_tree,
1876
specific_files=specific_files, pb=pb)
1877
if target_tree.inventory.root is None:
1884
for id_num, (file_id, path, changed_content, versioned, parent, name,
1885
kind, executable) in enumerate(change_list):
1886
if skip_root and file_id[0] is not None and parent[0] is None:
1888
trans_id = tt.trans_id_file_id(file_id)
1891
keep_content = False
1892
if kind[0] == 'file' and (backups or kind[1] is None):
1893
wt_sha1 = working_tree.get_file_sha1(file_id)
1894
if merge_modified.get(file_id) != wt_sha1:
1895
# acquire the basis tree lazily to prevent the
1896
# expense of accessing it when it's not needed ?
1897
# (Guessing, RBC, 200702)
1898
if basis_tree is None:
1899
basis_tree = working_tree.basis_tree()
1900
basis_tree.lock_read()
1901
if file_id in basis_tree:
1902
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1904
elif kind[1] is None and not versioned[1]:
1906
if kind[0] is not None:
1907
if not keep_content:
1908
tt.delete_contents(trans_id)
1909
elif kind[1] is not None:
1910
parent_trans_id = tt.trans_id_file_id(parent[0])
1911
by_parent = tt.by_parent()
1912
backup_name = _get_backup_name(name[0], by_parent,
1913
parent_trans_id, tt)
1914
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1915
new_trans_id = tt.create_path(name[0], parent_trans_id)
1916
if versioned == (True, True):
1917
tt.unversion_file(trans_id)
1918
tt.version_file(file_id, new_trans_id)
1919
# New contents should have the same unix perms as old
1922
trans_id = new_trans_id
1923
if kind[1] == 'directory':
1924
tt.create_directory(trans_id)
1925
elif kind[1] == 'symlink':
1926
tt.create_symlink(target_tree.get_symlink_target(file_id),
1928
elif kind[1] == 'file':
1929
deferred_files.append((file_id, (trans_id, mode_id)))
1930
if basis_tree is None:
1931
basis_tree = working_tree.basis_tree()
1932
basis_tree.lock_read()
1933
new_sha1 = target_tree.get_file_sha1(file_id)
1934
if (file_id in basis_tree and new_sha1 ==
1935
basis_tree.get_file_sha1(file_id)):
1936
if file_id in merge_modified:
1937
del merge_modified[file_id]
1939
merge_modified[file_id] = new_sha1
1941
# preserve the execute bit when backing up
1942
if keep_content and executable[0] == executable[1]:
1943
tt.set_executability(executable[1], trans_id)
1944
elif kind[1] != None:
1945
raise AssertionError(kind[1])
1946
if versioned == (False, True):
1947
tt.version_file(file_id, trans_id)
1948
if versioned == (True, False):
1949
tt.unversion_file(trans_id)
1950
if (name[1] is not None and
1951
(name[0] != name[1] or parent[0] != parent[1])):
1953
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1954
if executable[0] != executable[1] and kind[1] == "file":
1955
tt.set_executability(executable[1], trans_id)
1956
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1958
tt.create_file(bytes, trans_id, mode_id)
1960
if basis_tree is not None:
1962
return merge_modified
1965
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1966
"""Make many conflict-resolution attempts, but die if they fail"""
1967
if pass_func is None:
1968
pass_func = conflict_pass
1969
new_conflicts = set()
1972
pb.update('Resolution pass', n+1, 10)
1973
conflicts = tt.find_conflicts()
1974
if len(conflicts) == 0:
1975
return new_conflicts
1976
new_conflicts.update(pass_func(tt, conflicts))
1977
raise MalformedTransform(conflicts=conflicts)
1982
def conflict_pass(tt, conflicts, path_tree=None):
1983
"""Resolve some classes of conflicts.
1985
:param tt: The transform to resolve conflicts in
1986
:param conflicts: The conflicts to resolve
1987
:param path_tree: A Tree to get supplemental paths from
1989
new_conflicts = set()
1990
for c_type, conflict in ((c[0], c) for c in conflicts):
1991
if c_type == 'duplicate id':
1992
tt.unversion_file(conflict[1])
1993
new_conflicts.add((c_type, 'Unversioned existing file',
1994
conflict[1], conflict[2], ))
1995
elif c_type == 'duplicate':
1996
# files that were renamed take precedence
1997
final_parent = tt.final_parent(conflict[1])
1998
if tt.path_changed(conflict[1]):
1999
existing_file, new_file = conflict[2], conflict[1]
2001
existing_file, new_file = conflict[1], conflict[2]
2002
new_name = tt.final_name(existing_file)+'.moved'
2003
tt.adjust_path(new_name, final_parent, existing_file)
2004
new_conflicts.add((c_type, 'Moved existing file to',
2005
existing_file, new_file))
2006
elif c_type == 'parent loop':
2007
# break the loop by undoing one of the ops that caused the loop
2009
while not tt.path_changed(cur):
2010
cur = tt.final_parent(cur)
2011
new_conflicts.add((c_type, 'Cancelled move', cur,
2012
tt.final_parent(cur),))
2013
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2015
elif c_type == 'missing parent':
2016
trans_id = conflict[1]
2018
tt.cancel_deletion(trans_id)
2019
new_conflicts.add(('deleting parent', 'Not deleting',
2024
tt.final_name(trans_id)
2026
if path_tree is not None:
2027
file_id = tt.final_file_id(trans_id)
2029
file_id = tt.inactive_file_id(trans_id)
2030
entry = path_tree.inventory[file_id]
2031
# special-case the other tree root (move its
2032
# children to current root)
2033
if entry.parent_id is None:
2035
moved = _reparent_transform_children(
2036
tt, trans_id, tt.root)
2038
new_conflicts.add((c_type, 'Moved to root',
2041
parent_trans_id = tt.trans_id_file_id(
2043
tt.adjust_path(entry.name, parent_trans_id,
2046
tt.create_directory(trans_id)
2047
new_conflicts.add((c_type, 'Created directory', trans_id))
2048
elif c_type == 'unversioned parent':
2049
file_id = tt.inactive_file_id(conflict[1])
2050
# special-case the other tree root (move its children instead)
2051
if path_tree and file_id in path_tree:
2052
if path_tree.inventory[file_id].parent_id is None:
2054
tt.version_file(file_id, conflict[1])
2055
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2056
elif c_type == 'non-directory parent':
2057
parent_id = conflict[1]
2058
parent_parent = tt.final_parent(parent_id)
2059
parent_name = tt.final_name(parent_id)
2060
parent_file_id = tt.final_file_id(parent_id)
2061
new_parent_id = tt.new_directory(parent_name + '.new',
2062
parent_parent, parent_file_id)
2063
_reparent_transform_children(tt, parent_id, new_parent_id)
2064
if parent_file_id is not None:
2065
tt.unversion_file(parent_id)
2066
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2067
return new_conflicts
2070
def cook_conflicts(raw_conflicts, tt):
2071
"""Generate a list of cooked conflicts, sorted by file path"""
2072
from bzrlib.conflicts import Conflict
2073
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2074
return sorted(conflict_iter, key=Conflict.sort_key)
2077
def iter_cook_conflicts(raw_conflicts, tt):
2078
from bzrlib.conflicts import Conflict
2080
for conflict in raw_conflicts:
2081
c_type = conflict[0]
2082
action = conflict[1]
2083
modified_path = fp.get_path(conflict[2])
2084
modified_id = tt.final_file_id(conflict[2])
2085
if len(conflict) == 3:
2086
yield Conflict.factory(c_type, action=action, path=modified_path,
2087
file_id=modified_id)
2090
conflicting_path = fp.get_path(conflict[3])
2091
conflicting_id = tt.final_file_id(conflict[3])
2092
yield Conflict.factory(c_type, action=action, path=modified_path,
2093
file_id=modified_id,
2094
conflict_path=conflicting_path,
2095
conflict_file_id=conflicting_id)
2098
class _FileMover(object):
2099
"""Moves and deletes files for TreeTransform, tracking operations"""
2102
self.past_renames = []
2103
self.pending_deletions = []
2105
def rename(self, from_, to):
2106
"""Rename a file from one path to another. Functions like os.rename"""
2108
os.rename(from_, to)
2110
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2111
raise errors.FileExists(to, str(e))
2113
self.past_renames.append((from_, to))
2115
def pre_delete(self, from_, to):
2116
"""Rename a file out of the way and mark it for deletion.
2118
Unlike os.unlink, this works equally well for files and directories.
2119
:param from_: The current file path
2120
:param to: A temporary path for the file
2122
self.rename(from_, to)
2123
self.pending_deletions.append(to)
2126
"""Reverse all renames that have been performed"""
2127
for from_, to in reversed(self.past_renames):
2128
os.rename(to, from_)
2129
# after rollback, don't reuse _FileMover
2131
pending_deletions = None
2133
def apply_deletions(self):
2134
"""Apply all marked deletions"""
2135
for path in self.pending_deletions:
2137
# after apply_deletions, don't reuse _FileMover
2139
pending_deletions = None
added
removed
bzrlib/transform.py
