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."""
443
assert file_id is not None
444
unique_add(self._new_id, trans_id, file_id)
445
unique_add(self._r_new_id, file_id, trans_id)
447
def cancel_versioning(self, trans_id):
448
"""Undo a previous versioning of a file"""
449
file_id = self._new_id[trans_id]
450
del self._new_id[trans_id]
451
del self._r_new_id[file_id]
454
"""Determine the paths of all new and changed files"""
456
fp = FinalPaths(self)
457
for id_set in (self._new_name, self._new_parent, self._new_contents,
458
self._new_id, self._new_executability):
459
new_ids.update(id_set)
460
new_paths = [(fp.get_path(t), t) for t in new_ids]
464
def tree_kind(self, trans_id):
465
"""Determine the file kind in the working tree.
467
Raises NoSuchFile if the file does not exist
469
path = self._tree_id_paths.get(trans_id)
471
raise NoSuchFile(None)
473
return file_kind(self._tree.abspath(path))
475
if e.errno != errno.ENOENT:
478
raise NoSuchFile(path)
480
def final_kind(self, trans_id):
481
"""Determine the final file kind, after any changes applied.
483
Raises NoSuchFile if the file does not exist/has no contents.
484
(It is conceivable that a path would be created without the
485
corresponding contents insertion command)
487
if trans_id in self._new_contents:
488
return self._new_contents[trans_id]
489
elif trans_id in self._removed_contents:
490
raise NoSuchFile(None)
492
return self.tree_kind(trans_id)
494
def tree_file_id(self, trans_id):
495
"""Determine the file id associated with the trans_id in the tree"""
497
path = self._tree_id_paths[trans_id]
499
# the file is a new, unversioned file, or invalid trans_id
501
# the file is old; the old id is still valid
502
if self._new_root == trans_id:
503
return self._tree.get_root_id()
504
return self._tree.inventory.path2id(path)
506
def final_file_id(self, trans_id):
507
"""Determine the file id after any changes are applied, or None.
509
None indicates that the file will not be versioned after changes are
513
# there is a new id for this file
514
assert self._new_id[trans_id] is not None
515
return self._new_id[trans_id]
517
if trans_id in self._removed_id:
519
return self.tree_file_id(trans_id)
521
def inactive_file_id(self, trans_id):
522
"""Return the inactive file_id associated with a transaction id.
523
That is, the one in the tree or in non_present_ids.
524
The file_id may actually be active, too.
526
file_id = self.tree_file_id(trans_id)
527
if file_id is not None:
529
for key, value in self._non_present_ids.iteritems():
530
if value == trans_id:
533
def final_parent(self, trans_id):
534
"""Determine the parent file_id, after any changes are applied.
536
ROOT_PARENT is returned for the tree root.
539
return self._new_parent[trans_id]
541
return self.get_tree_parent(trans_id)
543
def final_name(self, trans_id):
544
"""Determine the final filename, after all changes are applied."""
546
return self._new_name[trans_id]
549
return os.path.basename(self._tree_id_paths[trans_id])
551
raise NoFinalPath(trans_id, self)
554
"""Return a map of parent: children for known parents.
556
Only new paths and parents of tree files with assigned ids are used.
559
items = list(self._new_parent.iteritems())
560
items.extend((t, self.final_parent(t)) for t in
561
self._tree_id_paths.keys())
562
for trans_id, parent_id in items:
563
if parent_id not in by_parent:
564
by_parent[parent_id] = set()
565
by_parent[parent_id].add(trans_id)
568
def path_changed(self, trans_id):
569
"""Return True if a trans_id's path has changed."""
570
return (trans_id in self._new_name) or (trans_id in self._new_parent)
572
def new_contents(self, trans_id):
573
return (trans_id in self._new_contents)
575
def find_conflicts(self):
576
"""Find any violations of inventory or filesystem invariants"""
577
if self._done is True:
578
raise ReusingTransform()
580
# ensure all children of all existent parents are known
581
# all children of non-existent parents are known, by definition.
582
self._add_tree_children()
583
by_parent = self.by_parent()
584
conflicts.extend(self._unversioned_parents(by_parent))
585
conflicts.extend(self._parent_loops())
586
conflicts.extend(self._duplicate_entries(by_parent))
587
conflicts.extend(self._duplicate_ids())
588
conflicts.extend(self._parent_type_conflicts(by_parent))
589
conflicts.extend(self._improper_versioning())
590
conflicts.extend(self._executability_conflicts())
591
conflicts.extend(self._overwrite_conflicts())
594
def _add_tree_children(self):
595
"""Add all the children of all active parents to the known paths.
597
Active parents are those which gain children, and those which are
598
removed. This is a necessary first step in detecting conflicts.
600
parents = self.by_parent().keys()
601
parents.extend([t for t in self._removed_contents if
602
self.tree_kind(t) == 'directory'])
603
for trans_id in self._removed_id:
604
file_id = self.tree_file_id(trans_id)
605
if file_id is not None:
606
if self._tree.inventory[file_id].kind == 'directory':
607
parents.append(trans_id)
608
elif self.tree_kind(trans_id) == 'directory':
609
parents.append(trans_id)
611
for parent_id in parents:
612
# ensure that all children are registered with the transaction
613
list(self.iter_tree_children(parent_id))
615
def iter_tree_children(self, parent_id):
616
"""Iterate through the entry's tree children, if any"""
618
path = self._tree_id_paths[parent_id]
622
children = os.listdir(self._tree.abspath(path))
624
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
628
for child in children:
629
childpath = joinpath(path, child)
630
if self._tree.is_control_filename(childpath):
632
yield self.trans_id_tree_path(childpath)
634
def has_named_child(self, by_parent, parent_id, name):
636
children = by_parent[parent_id]
639
for child in children:
640
if self.final_name(child) == name:
643
path = self._tree_id_paths[parent_id]
646
childpath = joinpath(path, name)
647
child_id = self._tree_path_ids.get(childpath)
649
return lexists(self._tree.abspath(childpath))
651
if self.final_parent(child_id) != parent_id:
653
if child_id in self._removed_contents:
654
# XXX What about dangling file-ids?
659
def _parent_loops(self):
660
"""No entry should be its own ancestor"""
662
for trans_id in self._new_parent:
665
while parent_id is not ROOT_PARENT:
668
parent_id = self.final_parent(parent_id)
671
if parent_id == trans_id:
672
conflicts.append(('parent loop', trans_id))
673
if parent_id in seen:
677
def _unversioned_parents(self, by_parent):
678
"""If parent directories are versioned, children must be versioned."""
680
for parent_id, children in by_parent.iteritems():
681
if parent_id is ROOT_PARENT:
683
if self.final_file_id(parent_id) is not None:
685
for child_id in children:
686
if self.final_file_id(child_id) is not None:
687
conflicts.append(('unversioned parent', parent_id))
691
def _improper_versioning(self):
692
"""Cannot version a file with no contents, or a bad type.
694
However, existing entries with no contents are okay.
697
for trans_id in self._new_id.iterkeys():
699
kind = self.final_kind(trans_id)
701
conflicts.append(('versioning no contents', trans_id))
703
if not InventoryEntry.versionable_kind(kind):
704
conflicts.append(('versioning bad kind', trans_id, kind))
707
def _executability_conflicts(self):
708
"""Check for bad executability changes.
710
Only versioned files may have their executability set, because
711
1. only versioned entries can have executability under windows
712
2. only files can be executable. (The execute bit on a directory
713
does not indicate searchability)
716
for trans_id in self._new_executability:
717
if self.final_file_id(trans_id) is None:
718
conflicts.append(('unversioned executability', trans_id))
721
non_file = self.final_kind(trans_id) != "file"
725
conflicts.append(('non-file executability', trans_id))
728
def _overwrite_conflicts(self):
729
"""Check for overwrites (not permitted on Win32)"""
731
for trans_id in self._new_contents:
733
self.tree_kind(trans_id)
736
if trans_id not in self._removed_contents:
737
conflicts.append(('overwrite', trans_id,
738
self.final_name(trans_id)))
741
def _duplicate_entries(self, by_parent):
742
"""No directory may have two entries with the same name."""
744
if (self._new_name, self._new_parent) == ({}, {}):
746
for children in by_parent.itervalues():
747
name_ids = [(self.final_name(t), t) for t in children]
748
if not self._case_sensitive_target:
749
name_ids = [(n.lower(), t) for n, t in name_ids]
753
for name, trans_id in name_ids:
755
kind = self.final_kind(trans_id)
758
file_id = self.final_file_id(trans_id)
759
if kind is None and file_id is None:
761
if name == last_name:
762
conflicts.append(('duplicate', last_trans_id, trans_id,
765
last_trans_id = trans_id
768
def _duplicate_ids(self):
769
"""Each inventory id may only be used once"""
771
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
773
all_ids = self._tree.all_file_ids()
774
active_tree_ids = all_ids.difference(removed_tree_ids)
775
for trans_id, file_id in self._new_id.iteritems():
776
if file_id in active_tree_ids:
777
old_trans_id = self.trans_id_tree_file_id(file_id)
778
conflicts.append(('duplicate id', old_trans_id, trans_id))
781
def _parent_type_conflicts(self, by_parent):
782
"""parents must have directory 'contents'."""
784
for parent_id, children in by_parent.iteritems():
785
if parent_id is ROOT_PARENT:
787
if not self._any_contents(children):
789
for child in children:
791
self.final_kind(child)
795
kind = self.final_kind(parent_id)
799
conflicts.append(('missing parent', parent_id))
800
elif kind != "directory":
801
conflicts.append(('non-directory parent', parent_id))
804
def _any_contents(self, trans_ids):
805
"""Return true if any of the trans_ids, will have contents."""
806
for trans_id in trans_ids:
808
kind = self.final_kind(trans_id)
814
def _limbo_name(self, trans_id):
815
"""Generate the limbo name of a file"""
816
limbo_name = self._limbo_files.get(trans_id)
817
if limbo_name is not None:
819
parent = self._new_parent.get(trans_id)
820
# if the parent directory is already in limbo (e.g. when building a
821
# tree), choose a limbo name inside the parent, to reduce further
823
use_direct_path = False
824
if self._new_contents.get(parent) == 'directory':
825
filename = self._new_name.get(trans_id)
826
if filename is not None:
827
if parent not in self._limbo_children:
828
self._limbo_children[parent] = set()
829
self._limbo_children_names[parent] = {}
830
use_direct_path = True
831
# the direct path can only be used if no other file has
832
# already taken this pathname, i.e. if the name is unused, or
833
# if it is already associated with this trans_id.
834
elif self._case_sensitive_target:
835
if (self._limbo_children_names[parent].get(filename)
836
in (trans_id, None)):
837
use_direct_path = True
839
for l_filename, l_trans_id in\
840
self._limbo_children_names[parent].iteritems():
841
if l_trans_id == trans_id:
843
if l_filename.lower() == filename.lower():
846
use_direct_path = True
849
limbo_name = pathjoin(self._limbo_files[parent], filename)
850
self._limbo_children[parent].add(trans_id)
851
self._limbo_children_names[parent][filename] = trans_id
853
limbo_name = pathjoin(self._limbodir, trans_id)
854
self._needs_rename.add(trans_id)
855
self._limbo_files[trans_id] = limbo_name
858
def _set_executability(self, path, entry, trans_id):
859
"""Set the executability of versioned files """
860
new_executability = self._new_executability[trans_id]
861
entry.executable = new_executability
862
if supports_executable():
863
abspath = self._tree.abspath(path)
864
current_mode = os.stat(abspath).st_mode
865
if new_executability:
868
to_mode = current_mode | (0100 & ~umask)
869
# Enable x-bit for others only if they can read it.
870
if current_mode & 0004:
871
to_mode |= 0001 & ~umask
872
if current_mode & 0040:
873
to_mode |= 0010 & ~umask
875
to_mode = current_mode & ~0111
876
os.chmod(abspath, to_mode)
878
def _new_entry(self, name, parent_id, file_id):
879
"""Helper function to create a new filesystem entry."""
880
trans_id = self.create_path(name, parent_id)
881
if file_id is not None:
882
self.version_file(file_id, trans_id)
885
def new_file(self, name, parent_id, contents, file_id=None,
887
"""Convenience method to create files.
889
name is the name of the file to create.
890
parent_id is the transaction id of the parent directory of the file.
891
contents is an iterator of bytestrings, which will be used to produce
893
:param file_id: The inventory ID of the file, if it is to be versioned.
894
:param executable: Only valid when a file_id has been supplied.
896
trans_id = self._new_entry(name, parent_id, file_id)
897
# TODO: rather than scheduling a set_executable call,
898
# have create_file create the file with the right mode.
899
self.create_file(contents, trans_id)
900
if executable is not None:
901
self.set_executability(executable, trans_id)
904
def new_directory(self, name, parent_id, file_id=None):
905
"""Convenience method to create directories.
907
name is the name of the directory to create.
908
parent_id is the transaction id of the parent directory of the
910
file_id is the inventory ID of the directory, if it is to be versioned.
912
trans_id = self._new_entry(name, parent_id, file_id)
913
self.create_directory(trans_id)
916
def new_symlink(self, name, parent_id, target, file_id=None):
917
"""Convenience method to create symbolic link.
919
name is the name of the symlink to create.
920
parent_id is the transaction id of the parent directory of the symlink.
921
target is a bytestring of the target of the symlink.
922
file_id is the inventory ID of the file, if it is to be versioned.
924
trans_id = self._new_entry(name, parent_id, file_id)
925
self.create_symlink(target, trans_id)
928
def _affected_ids(self):
929
"""Return the set of transform ids affected by the transform"""
930
trans_ids = set(self._removed_id)
931
trans_ids.update(self._new_id.keys())
932
trans_ids.update(self._removed_contents)
933
trans_ids.update(self._new_contents.keys())
934
trans_ids.update(self._new_executability.keys())
935
trans_ids.update(self._new_name.keys())
936
trans_ids.update(self._new_parent.keys())
939
def _get_file_id_maps(self):
940
"""Return mapping of file_ids to trans_ids in the to and from states"""
941
trans_ids = self._affected_ids()
944
# Build up two dicts: trans_ids associated with file ids in the
945
# FROM state, vs the TO state.
946
for trans_id in trans_ids:
947
from_file_id = self.tree_file_id(trans_id)
948
if from_file_id is not None:
949
from_trans_ids[from_file_id] = trans_id
950
to_file_id = self.final_file_id(trans_id)
951
if to_file_id is not None:
952
to_trans_ids[to_file_id] = trans_id
953
return from_trans_ids, to_trans_ids
955
def _from_file_data(self, from_trans_id, from_versioned, file_id):
956
"""Get data about a file in the from (tree) state
958
Return a (name, parent, kind, executable) tuple
960
from_path = self._tree_id_paths.get(from_trans_id)
962
# get data from working tree if versioned
963
from_entry = self._tree.inventory[file_id]
964
from_name = from_entry.name
965
from_parent = from_entry.parent_id
968
if from_path is None:
969
# File does not exist in FROM state
973
# File exists, but is not versioned. Have to use path-
975
from_name = os.path.basename(from_path)
976
tree_parent = self.get_tree_parent(from_trans_id)
977
from_parent = self.tree_file_id(tree_parent)
978
if from_path is not None:
979
from_kind, from_executable, from_stats = \
980
self._tree._comparison_data(from_entry, from_path)
983
from_executable = False
984
return from_name, from_parent, from_kind, from_executable
986
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
987
"""Get data about a file in the to (target) state
989
Return a (name, parent, kind, executable) tuple
991
to_name = self.final_name(to_trans_id)
993
to_kind = self.final_kind(to_trans_id)
996
to_parent = self.final_file_id(self.final_parent(to_trans_id))
997
if to_trans_id in self._new_executability:
998
to_executable = self._new_executability[to_trans_id]
999
elif to_trans_id == from_trans_id:
1000
to_executable = from_executable
1002
to_executable = False
1003
return to_name, to_parent, to_kind, to_executable
1005
def iter_changes(self):
1006
"""Produce output in the same format as Tree.iter_changes.
1008
Will produce nonsensical results if invoked while inventory/filesystem
1009
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1011
This reads the Transform, but only reproduces changes involving a
1012
file_id. Files that are not versioned in either of the FROM or TO
1013
states are not reflected.
1015
final_paths = FinalPaths(self)
1016
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1018
# Now iterate through all active file_ids
1019
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1021
from_trans_id = from_trans_ids.get(file_id)
1022
# find file ids, and determine versioning state
1023
if from_trans_id is None:
1024
from_versioned = False
1025
from_trans_id = to_trans_ids[file_id]
1027
from_versioned = True
1028
to_trans_id = to_trans_ids.get(file_id)
1029
if to_trans_id is None:
1030
to_versioned = False
1031
to_trans_id = from_trans_id
1035
from_name, from_parent, from_kind, from_executable = \
1036
self._from_file_data(from_trans_id, from_versioned, file_id)
1038
to_name, to_parent, to_kind, to_executable = \
1039
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1041
if not from_versioned:
1044
from_path = self._tree_id_paths.get(from_trans_id)
1045
if not to_versioned:
1048
to_path = final_paths.get_path(to_trans_id)
1049
if from_kind != to_kind:
1051
elif to_kind in ('file', 'symlink') and (
1052
to_trans_id != from_trans_id or
1053
to_trans_id in self._new_contents):
1055
if (not modified and from_versioned == to_versioned and
1056
from_parent==to_parent and from_name == to_name and
1057
from_executable == to_executable):
1059
results.append((file_id, (from_path, to_path), modified,
1060
(from_versioned, to_versioned),
1061
(from_parent, to_parent),
1062
(from_name, to_name),
1063
(from_kind, to_kind),
1064
(from_executable, to_executable)))
1065
return iter(sorted(results, key=lambda x:x[1]))
1067
def get_preview_tree(self):
1068
"""Return a tree representing the result of the transform.
1070
This tree only supports the subset of Tree functionality required
1071
by show_diff_trees. It must only be compared to tt._tree.
1073
return _PreviewTree(self)
1076
class TreeTransform(TreeTransformBase):
1077
"""Represent a tree transformation.
1079
This object is designed to support incremental generation of the transform,
1082
However, it gives optimum performance when parent directories are created
1083
before their contents. The transform is then able to put child files
1084
directly in their parent directory, avoiding later renames.
1086
It is easy to produce malformed transforms, but they are generally
1087
harmless. Attempting to apply a malformed transform will cause an
1088
exception to be raised before any modifications are made to the tree.
1090
Many kinds of malformed transforms can be corrected with the
1091
resolve_conflicts function. The remaining ones indicate programming error,
1092
such as trying to create a file with no path.
1094
Two sets of file creation methods are supplied. Convenience methods are:
1099
These are composed of the low-level methods:
1101
* create_file or create_directory or create_symlink
1105
Transform/Transaction ids
1106
-------------------------
1107
trans_ids are temporary ids assigned to all files involved in a transform.
1108
It's possible, even common, that not all files in the Tree have trans_ids.
1110
trans_ids are used because filenames and file_ids are not good enough
1111
identifiers; filenames change, and not all files have file_ids. File-ids
1112
are also associated with trans-ids, so that moving a file moves its
1115
trans_ids are only valid for the TreeTransform that generated them.
1119
Limbo is a temporary directory use to hold new versions of files.
1120
Files are added to limbo by create_file, create_directory, create_symlink,
1121
and their convenience variants (new_*). Files may be removed from limbo
1122
using cancel_creation. Files are renamed from limbo into their final
1123
location as part of TreeTransform.apply
1125
Limbo must be cleaned up, by either calling TreeTransform.apply or
1126
calling TreeTransform.finalize.
1128
Files are placed into limbo inside their parent directories, where
1129
possible. This reduces subsequent renames, and makes operations involving
1130
lots of files faster. This optimization is only possible if the parent
1131
directory is created *before* creating any of its children, so avoid
1132
creating children before parents, where possible.
1136
This temporary directory is used by _FileMover for storing files that are
1137
about to be deleted. In case of rollback, the files will be restored.
1138
FileMover does not delete files until it is sure that a rollback will not
1141
def __init__(self, tree, pb=DummyProgress()):
1142
"""Note: a tree_write lock is taken on the tree.
1144
Use TreeTransform.finalize() to release the lock (can be omitted if
1145
TreeTransform.apply() called).
1147
tree.lock_tree_write()
1150
control_files = tree._control_files
1151
limbodir = urlutils.local_path_from_url(
1152
control_files.controlfilename('limbo'))
1156
if e.errno == errno.EEXIST:
1157
raise ExistingLimbo(limbodir)
1158
deletiondir = urlutils.local_path_from_url(
1159
control_files.controlfilename('pending-deletion'))
1161
os.mkdir(deletiondir)
1163
if e.errno == errno.EEXIST:
1164
raise errors.ExistingPendingDeletion(deletiondir)
1169
TreeTransformBase.__init__(self, tree, limbodir, pb,
1170
tree.case_sensitive)
1171
self._deletiondir = deletiondir
1173
def apply(self, no_conflicts=False, _mover=None):
1174
"""Apply all changes to the inventory and filesystem.
1176
If filesystem or inventory conflicts are present, MalformedTransform
1179
If apply succeeds, finalize is not necessary.
1181
:param no_conflicts: if True, the caller guarantees there are no
1182
conflicts, so no check is made.
1183
:param _mover: Supply an alternate FileMover, for testing
1185
if not no_conflicts:
1186
conflicts = self.find_conflicts()
1187
if len(conflicts) != 0:
1188
raise MalformedTransform(conflicts=conflicts)
1189
inventory_delta = []
1190
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1193
mover = _FileMover()
1197
child_pb.update('Apply phase', 0, 2)
1198
self._apply_removals(inventory_delta, mover)
1199
child_pb.update('Apply phase', 1, 2)
1200
modified_paths = self._apply_insertions(inventory_delta, mover)
1205
mover.apply_deletions()
1208
self._tree.apply_inventory_delta(inventory_delta)
1211
return _TransformResults(modified_paths, self.rename_count)
1213
def _apply_removals(self, inventory_delta, mover):
1214
"""Perform tree operations that remove directory/inventory names.
1216
That is, delete files that are to be deleted, and put any files that
1217
need renaming into limbo. This must be done in strict child-to-parent
1220
tree_paths = list(self._tree_path_ids.iteritems())
1221
tree_paths.sort(reverse=True)
1222
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1224
for num, data in enumerate(tree_paths):
1225
path, trans_id = data
1226
child_pb.update('removing file', num, len(tree_paths))
1227
full_path = self._tree.abspath(path)
1228
if trans_id in self._removed_contents:
1229
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1231
elif trans_id in self._new_name or trans_id in \
1234
mover.rename(full_path, self._limbo_name(trans_id))
1236
if e.errno != errno.ENOENT:
1239
self.rename_count += 1
1240
if trans_id in self._removed_id:
1241
if trans_id == self._new_root:
1242
file_id = self._tree.get_root_id()
1244
file_id = self.tree_file_id(trans_id)
1245
assert file_id is not None
1246
# File-id isn't really being deleted, just moved
1247
if file_id in self._r_new_id:
1249
inventory_delta.append((path, None, file_id, None))
1253
def _apply_insertions(self, inventory_delta, mover):
1254
"""Perform tree operations that insert directory/inventory names.
1256
That is, create any files that need to be created, and restore from
1257
limbo any files that needed renaming. This must be done in strict
1258
parent-to-child order.
1260
new_paths = self.new_paths()
1262
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1265
for num, (path, trans_id) in enumerate(new_paths):
1267
child_pb.update('adding file', num, len(new_paths))
1268
if trans_id in self._new_contents or \
1269
self.path_changed(trans_id):
1270
full_path = self._tree.abspath(path)
1271
if trans_id in self._needs_rename:
1273
mover.rename(self._limbo_name(trans_id), full_path)
1275
# We may be renaming a dangling inventory id
1276
if e.errno != errno.ENOENT:
1279
self.rename_count += 1
1280
if trans_id in self._new_contents:
1281
modified_paths.append(full_path)
1282
completed_new.append(trans_id)
1283
file_id = self.final_file_id(trans_id)
1284
if file_id is not None and (trans_id in self._new_id or
1285
trans_id in self._new_name or trans_id in self._new_parent
1286
or trans_id in self._new_executability):
1288
kind = self.final_kind(trans_id)
1290
kind = self._tree.stored_kind(file_id)
1291
if trans_id in self._new_reference_revision:
1292
new_entry = inventory.TreeReference(
1293
self.final_file_id(trans_id),
1294
self._new_name[trans_id],
1295
self.final_file_id(self._new_parent[trans_id]),
1296
None, self._new_reference_revision[trans_id])
1298
new_entry = inventory.make_entry(kind,
1299
self.final_name(trans_id),
1300
self.final_file_id(self.final_parent(trans_id)),
1301
self.final_file_id(trans_id))
1303
old_path = self._tree.id2path(new_entry.file_id)
1304
except errors.NoSuchId:
1306
inventory_delta.append((old_path, path, new_entry.file_id,
1309
if trans_id in self._new_executability:
1310
self._set_executability(path, new_entry, trans_id)
1313
for trans_id in completed_new:
1314
del self._new_contents[trans_id]
1315
return modified_paths
1318
class TransformPreview(TreeTransformBase):
1319
"""A TreeTransform for generating preview trees.
1321
Unlike TreeTransform, this version works when the input tree is a
1322
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1323
unversioned files in the input tree.
1326
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1328
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1329
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1331
def canonical_path(self, path):
1334
def tree_kind(self, trans_id):
1335
path = self._tree_id_paths.get(trans_id)
1337
raise NoSuchFile(None)
1338
file_id = self._tree.path2id(path)
1339
return self._tree.kind(file_id)
1341
def _set_mode(self, trans_id, mode_id, typefunc):
1342
"""Set the mode of new file contents.
1343
The mode_id is the existing file to get the mode from (often the same
1344
as trans_id). The operation is only performed if there's a mode match
1345
according to typefunc.
1347
# is it ok to ignore this? probably
1350
def iter_tree_children(self, parent_id):
1351
"""Iterate through the entry's tree children, if any"""
1353
path = self._tree_id_paths[parent_id]
1356
file_id = self.tree_file_id(parent_id)
1357
for child in self._tree.inventory[file_id].children.iterkeys():
1358
childpath = joinpath(path, child)
1359
yield self.trans_id_tree_path(childpath)
1362
class _PreviewTree(object):
1363
"""Partial implementation of Tree to support show_diff_trees"""
1365
def __init__(self, transform):
1366
self._transform = transform
1368
def lock_read(self):
1369
# Perhaps in theory, this should lock the TreeTransform?
1375
def iter_changes(self, from_tree, include_unchanged=False,
1376
specific_files=None, pb=None, extra_trees=None,
1377
require_versioned=True, want_unversioned=False):
1378
"""See InterTree.iter_changes.
1380
This implementation does not support include_unchanged, specific_files,
1381
or want_unversioned. extra_trees, require_versioned, and pb are
1384
if from_tree is not self._transform._tree:
1385
raise ValueError('from_tree must be transform source tree.')
1386
if include_unchanged:
1387
raise ValueError('include_unchanged is not supported')
1388
if specific_files is not None:
1389
raise ValueError('specific_files is not supported')
1390
if want_unversioned:
1391
raise ValueError('want_unversioned is not supported')
1392
return self._transform.iter_changes()
1394
def kind(self, file_id):
1395
trans_id = self._transform.trans_id_file_id(file_id)
1396
return self._transform.final_kind(trans_id)
1398
def get_file_mtime(self, file_id, path=None):
1399
"""See Tree.get_file_mtime"""
1400
trans_id = self._transform.trans_id_file_id(file_id)
1401
name = self._transform._limbo_name(trans_id)
1402
return os.stat(name).st_mtime
1404
def get_file(self, file_id):
1405
"""See Tree.get_file"""
1406
trans_id = self._transform.trans_id_file_id(file_id)
1407
name = self._transform._limbo_name(trans_id)
1408
return open(name, 'rb')
1410
def get_symlink_target(self, file_id):
1411
"""See Tree.get_symlink_target"""
1412
trans_id = self._transform.trans_id_file_id(file_id)
1413
name = self._transform._limbo_name(trans_id)
1414
return os.readlink(name)
1416
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1417
"""See Tree.paths2ids"""
1421
def joinpath(parent, child):
1422
"""Join tree-relative paths, handling the tree root specially"""
1423
if parent is None or parent == "":
1426
return pathjoin(parent, child)
1429
class FinalPaths(object):
1430
"""Make path calculation cheap by memoizing paths.
1432
The underlying tree must not be manipulated between calls, or else
1433
the results will likely be incorrect.
1435
def __init__(self, transform):
1436
object.__init__(self)
1437
self._known_paths = {}
1438
self.transform = transform
1440
def _determine_path(self, trans_id):
1441
if trans_id == self.transform.root:
1443
name = self.transform.final_name(trans_id)
1444
parent_id = self.transform.final_parent(trans_id)
1445
if parent_id == self.transform.root:
1448
return pathjoin(self.get_path(parent_id), name)
1450
def get_path(self, trans_id):
1451
"""Find the final path associated with a trans_id"""
1452
if trans_id not in self._known_paths:
1453
self._known_paths[trans_id] = self._determine_path(trans_id)
1454
return self._known_paths[trans_id]
1457
def topology_sorted_ids(tree):
1458
"""Determine the topological order of the ids in a tree"""
1459
file_ids = list(tree)
1460
file_ids.sort(key=tree.id2path)
1464
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
1465
"""Create working tree for a branch, using a TreeTransform.
1467
This function should be used on empty trees, having a tree root at most.
1468
(see merge and revert functionality for working with existing trees)
1470
Existing files are handled like so:
1472
- Existing bzrdirs take precedence over creating new items. They are
1473
created as '%s.diverted' % name.
1474
- Otherwise, if the content on disk matches the content we are building,
1475
it is silently replaced.
1476
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1478
:param tree: The tree to convert wt into a copy of
1479
:param wt: The working tree that files will be placed into
1480
:param accelerator_tree: A tree which can be used for retrieving file
1481
contents more quickly than tree itself, i.e. a workingtree. tree
1482
will be used for cases where accelerator_tree's content is different.
1483
:param hardlink: If true, hard-link files to accelerator_tree, where
1484
possible. accelerator_tree must implement abspath, i.e. be a
1487
wt.lock_tree_write()
1491
if accelerator_tree is not None:
1492
accelerator_tree.lock_read()
1494
return _build_tree(tree, wt, accelerator_tree, hardlink)
1496
if accelerator_tree is not None:
1497
accelerator_tree.unlock()
1504
def _build_tree(tree, wt, accelerator_tree, hardlink):
1505
"""See build_tree."""
1506
for num, _unused in enumerate(wt.all_file_ids()):
1507
if num > 0: # more than just a root
1508
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1510
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1511
pp = ProgressPhase("Build phase", 2, top_pb)
1512
if tree.inventory.root is not None:
1513
# This is kind of a hack: we should be altering the root
1514
# as part of the regular tree shape diff logic.
1515
# The conditional test here is to avoid doing an
1516
# expensive operation (flush) every time the root id
1517
# is set within the tree, nor setting the root and thus
1518
# marking the tree as dirty, because we use two different
1519
# idioms here: tree interfaces and inventory interfaces.
1520
if wt.get_root_id() != tree.get_root_id():
1521
wt.set_root_id(tree.get_root_id())
1523
tt = TreeTransform(wt)
1527
file_trans_id[wt.get_root_id()] = \
1528
tt.trans_id_tree_file_id(wt.get_root_id())
1529
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1531
deferred_contents = []
1533
for num, (tree_path, entry) in \
1534
enumerate(tree.inventory.iter_entries_by_dir()):
1535
pb.update("Building tree", num - len(deferred_contents),
1536
len(tree.inventory))
1537
if entry.parent_id is None:
1540
file_id = entry.file_id
1541
target_path = wt.abspath(tree_path)
1543
kind = file_kind(target_path)
1547
if kind == "directory":
1549
bzrdir.BzrDir.open(target_path)
1550
except errors.NotBranchError:
1554
if (file_id not in divert and
1555
_content_match(tree, entry, file_id, kind,
1557
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1558
if kind == 'directory':
1560
if entry.parent_id not in file_trans_id:
1561
raise AssertionError(
1562
'entry %s parent id %r is not in file_trans_id %r'
1563
% (entry, entry.parent_id, file_trans_id))
1564
parent_id = file_trans_id[entry.parent_id]
1565
if entry.kind == 'file':
1566
# We *almost* replicate new_by_entry, so that we can defer
1567
# getting the file text, and get them all at once.
1568
trans_id = tt.create_path(entry.name, parent_id)
1569
file_trans_id[file_id] = trans_id
1570
tt.version_file(entry.file_id, trans_id)
1571
executable = tree.is_executable(entry.file_id, tree_path)
1572
if executable is not None:
1573
tt.set_executability(executable, trans_id)
1574
deferred_contents.append((entry.file_id, trans_id))
1576
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1579
new_trans_id = file_trans_id[file_id]
1580
old_parent = tt.trans_id_tree_path(tree_path)
1581
_reparent_children(tt, old_parent, new_trans_id)
1582
offset = num + 1 - len(deferred_contents)
1583
_create_files(tt, tree, deferred_contents, pb, offset,
1584
accelerator_tree, hardlink)
1588
divert_trans = set(file_trans_id[f] for f in divert)
1589
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1590
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1591
conflicts = cook_conflicts(raw_conflicts, tt)
1592
for conflict in conflicts:
1595
wt.add_conflicts(conflicts)
1596
except errors.UnsupportedOperation:
1598
result = tt.apply(no_conflicts=True)
1605
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1607
total = len(desired_files) + offset
1608
if accelerator_tree is None:
1609
new_desired_files = desired_files
1611
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1612
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1613
in iter if not (c or e[0] != e[1]))
1614
new_desired_files = []
1616
for file_id, trans_id in desired_files:
1617
accelerator_path = unchanged.get(file_id)
1618
if accelerator_path is None:
1619
new_desired_files.append((file_id, trans_id))
1621
pb.update('Adding file contents', count + offset, total)
1623
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1626
contents = accelerator_tree.get_file(file_id, accelerator_path)
1628
tt.create_file(contents, trans_id)
1633
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1634
new_desired_files)):
1635
tt.create_file(contents, trans_id)
1636
pb.update('Adding file contents', count + offset, total)
1639
def _reparent_children(tt, old_parent, new_parent):
1640
for child in tt.iter_tree_children(old_parent):
1641
tt.adjust_path(tt.final_name(child), new_parent, child)
1643
def _reparent_transform_children(tt, old_parent, new_parent):
1644
by_parent = tt.by_parent()
1645
for child in by_parent[old_parent]:
1646
tt.adjust_path(tt.final_name(child), new_parent, child)
1647
return by_parent[old_parent]
1649
def _content_match(tree, entry, file_id, kind, target_path):
1650
if entry.kind != kind:
1652
if entry.kind == "directory":
1654
if entry.kind == "file":
1655
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1657
elif entry.kind == "symlink":
1658
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1663
def resolve_checkout(tt, conflicts, divert):
1664
new_conflicts = set()
1665
for c_type, conflict in ((c[0], c) for c in conflicts):
1666
# Anything but a 'duplicate' would indicate programmer error
1667
assert c_type == 'duplicate', c_type
1668
# Now figure out which is new and which is old
1669
if tt.new_contents(conflict[1]):
1670
new_file = conflict[1]
1671
old_file = conflict[2]
1673
new_file = conflict[2]
1674
old_file = conflict[1]
1676
# We should only get here if the conflict wasn't completely
1678
final_parent = tt.final_parent(old_file)
1679
if new_file in divert:
1680
new_name = tt.final_name(old_file)+'.diverted'
1681
tt.adjust_path(new_name, final_parent, new_file)
1682
new_conflicts.add((c_type, 'Diverted to',
1683
new_file, old_file))
1685
new_name = tt.final_name(old_file)+'.moved'
1686
tt.adjust_path(new_name, final_parent, old_file)
1687
new_conflicts.add((c_type, 'Moved existing file to',
1688
old_file, new_file))
1689
return new_conflicts
1692
def new_by_entry(tt, entry, parent_id, tree):
1693
"""Create a new file according to its inventory entry"""
1697
contents = tree.get_file(entry.file_id).readlines()
1698
executable = tree.is_executable(entry.file_id)
1699
return tt.new_file(name, parent_id, contents, entry.file_id,
1701
elif kind in ('directory', 'tree-reference'):
1702
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1703
if kind == 'tree-reference':
1704
tt.set_tree_reference(entry.reference_revision, trans_id)
1706
elif kind == 'symlink':
1707
target = tree.get_symlink_target(entry.file_id)
1708
return tt.new_symlink(name, parent_id, target, entry.file_id)
1710
raise errors.BadFileKindError(name, kind)
1713
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1714
"""Create new file contents according to an inventory entry."""
1715
if entry.kind == "file":
1717
lines = tree.get_file(entry.file_id).readlines()
1718
tt.create_file(lines, trans_id, mode_id=mode_id)
1719
elif entry.kind == "symlink":
1720
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1721
elif entry.kind == "directory":
1722
tt.create_directory(trans_id)
1725
def create_entry_executability(tt, entry, trans_id):
1726
"""Set the executability of a trans_id according to an inventory entry"""
1727
if entry.kind == "file":
1728
tt.set_executability(entry.executable, trans_id)
1731
@deprecated_function(zero_fifteen)
1732
def find_interesting(working_tree, target_tree, filenames):
1733
"""Find the ids corresponding to specified filenames.
1735
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1737
working_tree.lock_read()
1739
target_tree.lock_read()
1741
return working_tree.paths2ids(filenames, [target_tree])
1743
target_tree.unlock()
1745
working_tree.unlock()
1748
@deprecated_function(zero_ninety)
1749
def change_entry(tt, file_id, working_tree, target_tree,
1750
trans_id_file_id, backups, trans_id, by_parent):
1751
"""Replace a file_id's contents with those from a target tree."""
1752
if file_id is None and target_tree is None:
1753
# skip the logic altogether in the deprecation test
1755
e_trans_id = trans_id_file_id(file_id)
1756
entry = target_tree.inventory[file_id]
1757
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1760
mode_id = e_trans_id
1763
tt.delete_contents(e_trans_id)
1765
parent_trans_id = trans_id_file_id(entry.parent_id)
1766
backup_name = get_backup_name(entry, by_parent,
1767
parent_trans_id, tt)
1768
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1769
tt.unversion_file(e_trans_id)
1770
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1771
tt.version_file(file_id, e_trans_id)
1772
trans_id[file_id] = e_trans_id
1773
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1774
create_entry_executability(tt, entry, e_trans_id)
1777
tt.set_executability(entry.executable, e_trans_id)
1778
if tt.final_name(e_trans_id) != entry.name:
1781
parent_id = tt.final_parent(e_trans_id)
1782
parent_file_id = tt.final_file_id(parent_id)
1783
if parent_file_id != entry.parent_id:
1788
parent_trans_id = trans_id_file_id(entry.parent_id)
1789
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1792
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1793
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1796
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1797
"""Produce a backup-style name that appears to be available"""
1801
yield "%s.~%d~" % (name, counter)
1803
for new_name in name_gen():
1804
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1808
def _entry_changes(file_id, entry, working_tree):
1809
"""Determine in which ways the inventory entry has changed.
1811
Returns booleans: has_contents, content_mod, meta_mod
1812
has_contents means there are currently contents, but they differ
1813
contents_mod means contents need to be modified
1814
meta_mod means the metadata needs to be modified
1816
cur_entry = working_tree.inventory[file_id]
1818
working_kind = working_tree.kind(file_id)
1821
has_contents = False
1824
if has_contents is True:
1825
if entry.kind != working_kind:
1826
contents_mod, meta_mod = True, False
1828
cur_entry._read_tree_state(working_tree.id2path(file_id),
1830
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1831
cur_entry._forget_tree_state()
1832
return has_contents, contents_mod, meta_mod
1835
def revert(working_tree, target_tree, filenames, backups=False,
1836
pb=DummyProgress(), change_reporter=None):
1837
"""Revert a working tree's contents to those of a target tree."""
1838
target_tree.lock_read()
1839
tt = TreeTransform(working_tree, pb)
1841
pp = ProgressPhase("Revert phase", 3, pb)
1843
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1845
merge_modified = _alter_files(working_tree, target_tree, tt,
1846
child_pb, filenames, backups)
1850
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1852
raw_conflicts = resolve_conflicts(tt, child_pb,
1853
lambda t, c: conflict_pass(t, c, target_tree))
1856
conflicts = cook_conflicts(raw_conflicts, tt)
1858
change_reporter = delta._ChangeReporter(
1859
unversioned_filter=working_tree.is_ignored)
1860
delta.report_changes(tt.iter_changes(), change_reporter)
1861
for conflict in conflicts:
1865
working_tree.set_merge_modified(merge_modified)
1867
target_tree.unlock()
1873
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1875
merge_modified = working_tree.merge_modified()
1876
change_list = target_tree.iter_changes(working_tree,
1877
specific_files=specific_files, pb=pb)
1878
if target_tree.inventory.root is None:
1885
for id_num, (file_id, path, changed_content, versioned, parent, name,
1886
kind, executable) in enumerate(change_list):
1887
if skip_root and file_id[0] is not None and parent[0] is None:
1889
trans_id = tt.trans_id_file_id(file_id)
1892
keep_content = False
1893
if kind[0] == 'file' and (backups or kind[1] is None):
1894
wt_sha1 = working_tree.get_file_sha1(file_id)
1895
if merge_modified.get(file_id) != wt_sha1:
1896
# acquire the basis tree lazily to prevent the
1897
# expense of accessing it when it's not needed ?
1898
# (Guessing, RBC, 200702)
1899
if basis_tree is None:
1900
basis_tree = working_tree.basis_tree()
1901
basis_tree.lock_read()
1902
if file_id in basis_tree:
1903
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1905
elif kind[1] is None and not versioned[1]:
1907
if kind[0] is not None:
1908
if not keep_content:
1909
tt.delete_contents(trans_id)
1910
elif kind[1] is not None:
1911
parent_trans_id = tt.trans_id_file_id(parent[0])
1912
by_parent = tt.by_parent()
1913
backup_name = _get_backup_name(name[0], by_parent,
1914
parent_trans_id, tt)
1915
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1916
new_trans_id = tt.create_path(name[0], parent_trans_id)
1917
if versioned == (True, True):
1918
tt.unversion_file(trans_id)
1919
tt.version_file(file_id, new_trans_id)
1920
# New contents should have the same unix perms as old
1923
trans_id = new_trans_id
1924
if kind[1] == 'directory':
1925
tt.create_directory(trans_id)
1926
elif kind[1] == 'symlink':
1927
tt.create_symlink(target_tree.get_symlink_target(file_id),
1929
elif kind[1] == 'file':
1930
deferred_files.append((file_id, (trans_id, mode_id)))
1931
if basis_tree is None:
1932
basis_tree = working_tree.basis_tree()
1933
basis_tree.lock_read()
1934
new_sha1 = target_tree.get_file_sha1(file_id)
1935
if (file_id in basis_tree and new_sha1 ==
1936
basis_tree.get_file_sha1(file_id)):
1937
if file_id in merge_modified:
1938
del merge_modified[file_id]
1940
merge_modified[file_id] = new_sha1
1942
# preserve the execute bit when backing up
1943
if keep_content and executable[0] == executable[1]:
1944
tt.set_executability(executable[1], trans_id)
1946
assert kind[1] is None
1947
if versioned == (False, True):
1948
tt.version_file(file_id, trans_id)
1949
if versioned == (True, False):
1950
tt.unversion_file(trans_id)
1951
if (name[1] is not None and
1952
(name[0] != name[1] or parent[0] != parent[1])):
1954
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1955
if executable[0] != executable[1] and kind[1] == "file":
1956
tt.set_executability(executable[1], trans_id)
1957
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1959
tt.create_file(bytes, trans_id, mode_id)
1961
if basis_tree is not None:
1963
return merge_modified
1966
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1967
"""Make many conflict-resolution attempts, but die if they fail"""
1968
if pass_func is None:
1969
pass_func = conflict_pass
1970
new_conflicts = set()
1973
pb.update('Resolution pass', n+1, 10)
1974
conflicts = tt.find_conflicts()
1975
if len(conflicts) == 0:
1976
return new_conflicts
1977
new_conflicts.update(pass_func(tt, conflicts))
1978
raise MalformedTransform(conflicts=conflicts)
1983
def conflict_pass(tt, conflicts, path_tree=None):
1984
"""Resolve some classes of conflicts.
1986
:param tt: The transform to resolve conflicts in
1987
:param conflicts: The conflicts to resolve
1988
:param path_tree: A Tree to get supplemental paths from
1990
new_conflicts = set()
1991
for c_type, conflict in ((c[0], c) for c in conflicts):
1992
if c_type == 'duplicate id':
1993
tt.unversion_file(conflict[1])
1994
new_conflicts.add((c_type, 'Unversioned existing file',
1995
conflict[1], conflict[2], ))
1996
elif c_type == 'duplicate':
1997
# files that were renamed take precedence
1998
final_parent = tt.final_parent(conflict[1])
1999
if tt.path_changed(conflict[1]):
2000
existing_file, new_file = conflict[2], conflict[1]
2002
existing_file, new_file = conflict[1], conflict[2]
2003
new_name = tt.final_name(existing_file)+'.moved'
2004
tt.adjust_path(new_name, final_parent, existing_file)
2005
new_conflicts.add((c_type, 'Moved existing file to',
2006
existing_file, new_file))
2007
elif c_type == 'parent loop':
2008
# break the loop by undoing one of the ops that caused the loop
2010
while not tt.path_changed(cur):
2011
cur = tt.final_parent(cur)
2012
new_conflicts.add((c_type, 'Cancelled move', cur,
2013
tt.final_parent(cur),))
2014
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2016
elif c_type == 'missing parent':
2017
trans_id = conflict[1]
2019
tt.cancel_deletion(trans_id)
2020
new_conflicts.add(('deleting parent', 'Not deleting',
2025
tt.final_name(trans_id)
2027
if path_tree is not None:
2028
file_id = tt.final_file_id(trans_id)
2030
file_id = tt.inactive_file_id(trans_id)
2031
entry = path_tree.inventory[file_id]
2032
# special-case the other tree root (move its
2033
# children to current root)
2034
if entry.parent_id is None:
2036
moved = _reparent_transform_children(
2037
tt, trans_id, tt.root)
2039
new_conflicts.add((c_type, 'Moved to root',
2042
parent_trans_id = tt.trans_id_file_id(
2044
tt.adjust_path(entry.name, parent_trans_id,
2047
tt.create_directory(trans_id)
2048
new_conflicts.add((c_type, 'Created directory', trans_id))
2049
elif c_type == 'unversioned parent':
2050
file_id = tt.inactive_file_id(conflict[1])
2051
# special-case the other tree root (move its children instead)
2052
if path_tree and file_id in path_tree:
2053
if path_tree.inventory[file_id].parent_id is None:
2055
tt.version_file(file_id, conflict[1])
2056
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2057
elif c_type == 'non-directory parent':
2058
parent_id = conflict[1]
2059
parent_parent = tt.final_parent(parent_id)
2060
parent_name = tt.final_name(parent_id)
2061
parent_file_id = tt.final_file_id(parent_id)
2062
new_parent_id = tt.new_directory(parent_name + '.new',
2063
parent_parent, parent_file_id)
2064
_reparent_transform_children(tt, parent_id, new_parent_id)
2065
if parent_file_id is not None:
2066
tt.unversion_file(parent_id)
2067
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2068
return new_conflicts
2071
def cook_conflicts(raw_conflicts, tt):
2072
"""Generate a list of cooked conflicts, sorted by file path"""
2073
from bzrlib.conflicts import Conflict
2074
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2075
return sorted(conflict_iter, key=Conflict.sort_key)
2078
def iter_cook_conflicts(raw_conflicts, tt):
2079
from bzrlib.conflicts import Conflict
2081
for conflict in raw_conflicts:
2082
c_type = conflict[0]
2083
action = conflict[1]
2084
modified_path = fp.get_path(conflict[2])
2085
modified_id = tt.final_file_id(conflict[2])
2086
if len(conflict) == 3:
2087
yield Conflict.factory(c_type, action=action, path=modified_path,
2088
file_id=modified_id)
2091
conflicting_path = fp.get_path(conflict[3])
2092
conflicting_id = tt.final_file_id(conflict[3])
2093
yield Conflict.factory(c_type, action=action, path=modified_path,
2094
file_id=modified_id,
2095
conflict_path=conflicting_path,
2096
conflict_file_id=conflicting_id)
2099
class _FileMover(object):
2100
"""Moves and deletes files for TreeTransform, tracking operations"""
2103
self.past_renames = []
2104
self.pending_deletions = []
2106
def rename(self, from_, to):
2107
"""Rename a file from one path to another. Functions like os.rename"""
2109
os.rename(from_, to)
2111
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2112
raise errors.FileExists(to, str(e))
2114
self.past_renames.append((from_, to))
2116
def pre_delete(self, from_, to):
2117
"""Rename a file out of the way and mark it for deletion.
2119
Unlike os.unlink, this works equally well for files and directories.
2120
:param from_: The current file path
2121
:param to: A temporary path for the file
2123
self.rename(from_, to)
2124
self.pending_deletions.append(to)
2127
"""Reverse all renames that have been performed"""
2128
for from_, to in reversed(self.past_renames):
2129
os.rename(to, from_)
2130
# after rollback, don't reuse _FileMover
2132
pending_deletions = None
2134
def apply_deletions(self):
2135
"""Apply all marked deletions"""
2136
for path in self.pending_deletions:
2138
# after apply_deletions, don't reuse _FileMover
2140
pending_deletions = None
added
removed
bzrlib/transform.py
