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.filters import filtered_writelines, filters_for_path
36
from bzrlib.inventory import InventoryEntry
37
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
38
delete_any, has_symlinks)
39
from bzrlib.progress import DummyProgress, ProgressPhase
40
from bzrlib.symbol_versioning import (
45
from bzrlib.trace import mutter, warning
46
from bzrlib import tree
48
import bzrlib.urlutils as urlutils
51
ROOT_PARENT = "root-parent"
54
def unique_add(map, key, value):
56
raise DuplicateKey(key=key)
60
class _TransformResults(object):
61
def __init__(self, modified_paths, rename_count):
63
self.modified_paths = modified_paths
64
self.rename_count = rename_count
67
class TreeTransformBase(object):
68
"""The base class for TreeTransform and TreeTransformBase"""
70
def __init__(self, tree, limbodir, pb=DummyProgress(),
74
:param tree: The tree that will be transformed, but not necessarily
76
:param limbodir: A directory where new files can be stored until
77
they are installed in their proper places
78
:param pb: A ProgressBar indicating how much progress is being made
79
:param case_sensitive: If True, the target of the transform is
80
case sensitive, not just case preserving.
84
self._limbodir = limbodir
85
self._deletiondir = None
87
# mapping of trans_id -> new basename
89
# mapping of trans_id -> new parent trans_id
91
# mapping of trans_id with new contents -> new file_kind
92
self._new_contents = {}
93
# A mapping of transform ids to their limbo filename
94
self._limbo_files = {}
95
# A mapping of transform ids to a set of the transform ids of children
96
# that their limbo directory has
97
self._limbo_children = {}
98
# Map transform ids to maps of child filename to child transform id
99
self._limbo_children_names = {}
100
# List of transform ids that need to be renamed from limbo into place
101
self._needs_rename = set()
102
# Set of trans_ids whose contents will be removed
103
self._removed_contents = set()
104
# Mapping of trans_id -> new execute-bit value
105
self._new_executability = {}
106
# Mapping of trans_id -> new tree-reference value
107
self._new_reference_revision = {}
108
# Mapping of trans_id -> new file_id
110
# Mapping of old file-id -> trans_id
111
self._non_present_ids = {}
112
# Mapping of new file_id -> trans_id
114
# Set of file_ids that will be removed
115
self._removed_id = set()
116
# Mapping of path in old tree -> trans_id
117
self._tree_path_ids = {}
118
# Mapping trans_id -> path in old tree
119
self._tree_id_paths = {}
120
# Cache of realpath results, to speed up canonical_path
122
# Cache of relpath results, to speed up canonical_path
124
# The trans_id that will be used as the tree root
125
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
126
# Indictor of whether the transform has been applied
130
# Whether the target is case sensitive
131
self._case_sensitive_target = case_sensitive
132
# A counter of how many files have been renamed
133
self.rename_count = 0
135
def __get_root(self):
136
return self._new_root
138
root = property(__get_root)
141
"""Release the working tree lock, if held, clean up limbo dir.
143
This is required if apply has not been invoked, but can be invoked
146
if self._tree is None:
149
entries = [(self._limbo_name(t), t, k) for t, k in
150
self._new_contents.iteritems()]
151
entries.sort(reverse=True)
152
for path, trans_id, kind in entries:
153
if kind == "directory":
158
os.rmdir(self._limbodir)
160
# We don't especially care *why* the dir is immortal.
161
raise ImmortalLimbo(self._limbodir)
163
if self._deletiondir is not None:
164
os.rmdir(self._deletiondir)
166
raise errors.ImmortalPendingDeletion(self._deletiondir)
171
def _assign_id(self):
172
"""Produce a new tranform id"""
173
new_id = "new-%s" % self._id_number
177
def create_path(self, name, parent):
178
"""Assign a transaction id to a new path"""
179
trans_id = self._assign_id()
180
unique_add(self._new_name, trans_id, name)
181
unique_add(self._new_parent, trans_id, parent)
184
def adjust_path(self, name, parent, trans_id):
185
"""Change the path that is assigned to a transaction id."""
186
if trans_id == self._new_root:
188
previous_parent = self._new_parent.get(trans_id)
189
previous_name = self._new_name.get(trans_id)
190
self._new_name[trans_id] = name
191
self._new_parent[trans_id] = parent
192
if (trans_id in self._limbo_files and
193
trans_id not in self._needs_rename):
194
self._rename_in_limbo([trans_id])
195
self._limbo_children[previous_parent].remove(trans_id)
196
del self._limbo_children_names[previous_parent][previous_name]
198
def _rename_in_limbo(self, trans_ids):
199
"""Fix limbo names so that the right final path is produced.
201
This means we outsmarted ourselves-- we tried to avoid renaming
202
these files later by creating them with their final names in their
203
final parents. But now the previous name or parent is no longer
204
suitable, so we have to rename them.
206
Even for trans_ids that have no new contents, we must remove their
207
entries from _limbo_files, because they are now stale.
209
for trans_id in trans_ids:
210
old_path = self._limbo_files.pop(trans_id)
211
if trans_id not in self._new_contents:
213
new_path = self._limbo_name(trans_id)
214
os.rename(old_path, new_path)
216
def adjust_root_path(self, name, parent):
217
"""Emulate moving the root by moving all children, instead.
219
We do this by undoing the association of root's transaction id with the
220
current tree. This allows us to create a new directory with that
221
transaction id. We unversion the root directory and version the
222
physically new directory, and hope someone versions the tree root
225
old_root = self._new_root
226
old_root_file_id = self.final_file_id(old_root)
227
# force moving all children of root
228
for child_id in self.iter_tree_children(old_root):
229
if child_id != parent:
230
self.adjust_path(self.final_name(child_id),
231
self.final_parent(child_id), child_id)
232
file_id = self.final_file_id(child_id)
233
if file_id is not None:
234
self.unversion_file(child_id)
235
self.version_file(file_id, child_id)
237
# the physical root needs a new transaction id
238
self._tree_path_ids.pop("")
239
self._tree_id_paths.pop(old_root)
240
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
241
if parent == old_root:
242
parent = self._new_root
243
self.adjust_path(name, parent, old_root)
244
self.create_directory(old_root)
245
self.version_file(old_root_file_id, old_root)
246
self.unversion_file(self._new_root)
248
def trans_id_tree_file_id(self, inventory_id):
249
"""Determine the transaction id of a working tree file.
251
This reflects only files that already exist, not ones that will be
252
added by transactions.
254
path = self._tree.id2path(inventory_id)
255
return self.trans_id_tree_path(path)
257
def trans_id_file_id(self, file_id):
258
"""Determine or set the transaction id associated with a file ID.
259
A new id is only created for file_ids that were never present. If
260
a transaction has been unversioned, it is deliberately still returned.
261
(this will likely lead to an unversioned parent conflict.)
263
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
264
return self._r_new_id[file_id]
265
elif file_id in self._tree.inventory:
266
return self.trans_id_tree_file_id(file_id)
267
elif file_id in self._non_present_ids:
268
return self._non_present_ids[file_id]
270
trans_id = self._assign_id()
271
self._non_present_ids[file_id] = trans_id
274
def canonical_path(self, path):
275
"""Get the canonical tree-relative path"""
276
# don't follow final symlinks
277
abs = self._tree.abspath(path)
278
if abs in self._relpaths:
279
return self._relpaths[abs]
280
dirname, basename = os.path.split(abs)
281
if dirname not in self._realpaths:
282
self._realpaths[dirname] = os.path.realpath(dirname)
283
dirname = self._realpaths[dirname]
284
abs = pathjoin(dirname, basename)
285
if dirname in self._relpaths:
286
relpath = pathjoin(self._relpaths[dirname], basename)
287
relpath = relpath.rstrip('/\\')
289
relpath = self._tree.relpath(abs)
290
self._relpaths[abs] = relpath
293
def trans_id_tree_path(self, path):
294
"""Determine (and maybe set) the transaction ID for a tree path."""
295
path = self.canonical_path(path)
296
if path not in self._tree_path_ids:
297
self._tree_path_ids[path] = self._assign_id()
298
self._tree_id_paths[self._tree_path_ids[path]] = path
299
return self._tree_path_ids[path]
301
def get_tree_parent(self, trans_id):
302
"""Determine id of the parent in the tree."""
303
path = self._tree_id_paths[trans_id]
306
return self.trans_id_tree_path(os.path.dirname(path))
308
def create_file(self, contents, trans_id, mode_id=None):
309
"""Schedule creation of a new file.
313
Contents is an iterator of strings, all of which will be written
314
to the target destination.
316
New file takes the permissions of any existing file with that id,
317
unless mode_id is specified.
319
name = self._limbo_name(trans_id)
323
unique_add(self._new_contents, trans_id, 'file')
325
# Clean up the file, it never got registered so
326
# TreeTransform.finalize() won't clean it up.
331
filtered_writelines(f, contents, filters_for_path(name))
334
self._set_mode(trans_id, mode_id, S_ISREG)
336
def _set_mode(self, trans_id, mode_id, typefunc):
337
"""Set the mode of new file contents.
338
The mode_id is the existing file to get the mode from (often the same
339
as trans_id). The operation is only performed if there's a mode match
340
according to typefunc.
345
old_path = self._tree_id_paths[mode_id]
349
mode = os.stat(self._tree.abspath(old_path)).st_mode
351
if e.errno == errno.ENOENT:
356
os.chmod(self._limbo_name(trans_id), mode)
358
def create_hardlink(self, path, trans_id):
359
"""Schedule creation of a hard link"""
360
name = self._limbo_name(trans_id)
364
if e.errno != errno.EPERM:
366
raise errors.HardLinkNotSupported(path)
368
unique_add(self._new_contents, trans_id, 'file')
370
# Clean up the file, it never got registered so
371
# TreeTransform.finalize() won't clean it up.
375
def create_directory(self, trans_id):
376
"""Schedule creation of a new directory.
378
See also new_directory.
380
os.mkdir(self._limbo_name(trans_id))
381
unique_add(self._new_contents, trans_id, 'directory')
383
def create_symlink(self, target, trans_id):
384
"""Schedule creation of a new symbolic link.
386
target is a bytestring.
387
See also new_symlink.
390
os.symlink(target, self._limbo_name(trans_id))
391
unique_add(self._new_contents, trans_id, 'symlink')
394
path = FinalPaths(self).get_path(trans_id)
397
raise UnableCreateSymlink(path=path)
399
def cancel_creation(self, trans_id):
400
"""Cancel the creation of new file contents."""
401
del self._new_contents[trans_id]
402
children = self._limbo_children.get(trans_id)
403
# if this is a limbo directory with children, move them before removing
405
if children is not None:
406
self._rename_in_limbo(children)
407
del self._limbo_children[trans_id]
408
del self._limbo_children_names[trans_id]
409
delete_any(self._limbo_name(trans_id))
411
def delete_contents(self, trans_id):
412
"""Schedule the contents of a path entry for deletion"""
413
self.tree_kind(trans_id)
414
self._removed_contents.add(trans_id)
416
def cancel_deletion(self, trans_id):
417
"""Cancel a scheduled deletion"""
418
self._removed_contents.remove(trans_id)
420
def unversion_file(self, trans_id):
421
"""Schedule a path entry to become unversioned"""
422
self._removed_id.add(trans_id)
424
def delete_versioned(self, trans_id):
425
"""Delete and unversion a versioned file"""
426
self.delete_contents(trans_id)
427
self.unversion_file(trans_id)
429
def set_executability(self, executability, trans_id):
430
"""Schedule setting of the 'execute' bit
431
To unschedule, set to None
433
if executability is None:
434
del self._new_executability[trans_id]
436
unique_add(self._new_executability, trans_id, executability)
438
def set_tree_reference(self, revision_id, trans_id):
439
"""Set the reference associated with a directory"""
440
unique_add(self._new_reference_revision, trans_id, revision_id)
442
def version_file(self, file_id, trans_id):
443
"""Schedule a file to become versioned."""
444
assert file_id is not None
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
# there is a new id for this file
515
assert self._new_id[trans_id] is not None
516
return self._new_id[trans_id]
518
if trans_id in self._removed_id:
520
return self.tree_file_id(trans_id)
522
def inactive_file_id(self, trans_id):
523
"""Return the inactive file_id associated with a transaction id.
524
That is, the one in the tree or in non_present_ids.
525
The file_id may actually be active, too.
527
file_id = self.tree_file_id(trans_id)
528
if file_id is not None:
530
for key, value in self._non_present_ids.iteritems():
531
if value == trans_id:
534
def final_parent(self, trans_id):
535
"""Determine the parent file_id, after any changes are applied.
537
ROOT_PARENT is returned for the tree root.
540
return self._new_parent[trans_id]
542
return self.get_tree_parent(trans_id)
544
def final_name(self, trans_id):
545
"""Determine the final filename, after all changes are applied."""
547
return self._new_name[trans_id]
550
return os.path.basename(self._tree_id_paths[trans_id])
552
raise NoFinalPath(trans_id, self)
555
"""Return a map of parent: children for known parents.
557
Only new paths and parents of tree files with assigned ids are used.
560
items = list(self._new_parent.iteritems())
561
items.extend((t, self.final_parent(t)) for t in
562
self._tree_id_paths.keys())
563
for trans_id, parent_id in items:
564
if parent_id not in by_parent:
565
by_parent[parent_id] = set()
566
by_parent[parent_id].add(trans_id)
569
def path_changed(self, trans_id):
570
"""Return True if a trans_id's path has changed."""
571
return (trans_id in self._new_name) or (trans_id in self._new_parent)
573
def new_contents(self, trans_id):
574
return (trans_id in self._new_contents)
576
def find_conflicts(self):
577
"""Find any violations of inventory or filesystem invariants"""
578
if self._done is True:
579
raise ReusingTransform()
581
# ensure all children of all existent parents are known
582
# all children of non-existent parents are known, by definition.
583
self._add_tree_children()
584
by_parent = self.by_parent()
585
conflicts.extend(self._unversioned_parents(by_parent))
586
conflicts.extend(self._parent_loops())
587
conflicts.extend(self._duplicate_entries(by_parent))
588
conflicts.extend(self._duplicate_ids())
589
conflicts.extend(self._parent_type_conflicts(by_parent))
590
conflicts.extend(self._improper_versioning())
591
conflicts.extend(self._executability_conflicts())
592
conflicts.extend(self._overwrite_conflicts())
595
def _add_tree_children(self):
596
"""Add all the children of all active parents to the known paths.
598
Active parents are those which gain children, and those which are
599
removed. This is a necessary first step in detecting conflicts.
601
parents = self.by_parent().keys()
602
parents.extend([t for t in self._removed_contents if
603
self.tree_kind(t) == 'directory'])
604
for trans_id in self._removed_id:
605
file_id = self.tree_file_id(trans_id)
606
if file_id is not None:
607
if self._tree.inventory[file_id].kind == 'directory':
608
parents.append(trans_id)
609
elif self.tree_kind(trans_id) == 'directory':
610
parents.append(trans_id)
612
for parent_id in parents:
613
# ensure that all children are registered with the transaction
614
list(self.iter_tree_children(parent_id))
616
def iter_tree_children(self, parent_id):
617
"""Iterate through the entry's tree children, if any"""
619
path = self._tree_id_paths[parent_id]
623
children = os.listdir(self._tree.abspath(path))
625
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
629
for child in children:
630
childpath = joinpath(path, child)
631
if self._tree.is_control_filename(childpath):
633
yield self.trans_id_tree_path(childpath)
635
def has_named_child(self, by_parent, parent_id, name):
637
children = by_parent[parent_id]
640
for child in children:
641
if self.final_name(child) == name:
644
path = self._tree_id_paths[parent_id]
647
childpath = joinpath(path, name)
648
child_id = self._tree_path_ids.get(childpath)
650
return lexists(self._tree.abspath(childpath))
652
if self.final_parent(child_id) != parent_id:
654
if child_id in self._removed_contents:
655
# XXX What about dangling file-ids?
660
def _parent_loops(self):
661
"""No entry should be its own ancestor"""
663
for trans_id in self._new_parent:
666
while parent_id is not ROOT_PARENT:
669
parent_id = self.final_parent(parent_id)
672
if parent_id == trans_id:
673
conflicts.append(('parent loop', trans_id))
674
if parent_id in seen:
678
def _unversioned_parents(self, by_parent):
679
"""If parent directories are versioned, children must be versioned."""
681
for parent_id, children in by_parent.iteritems():
682
if parent_id is ROOT_PARENT:
684
if self.final_file_id(parent_id) is not None:
686
for child_id in children:
687
if self.final_file_id(child_id) is not None:
688
conflicts.append(('unversioned parent', parent_id))
692
def _improper_versioning(self):
693
"""Cannot version a file with no contents, or a bad type.
695
However, existing entries with no contents are okay.
698
for trans_id in self._new_id.iterkeys():
700
kind = self.final_kind(trans_id)
702
conflicts.append(('versioning no contents', trans_id))
704
if not InventoryEntry.versionable_kind(kind):
705
conflicts.append(('versioning bad kind', trans_id, kind))
708
def _executability_conflicts(self):
709
"""Check for bad executability changes.
711
Only versioned files may have their executability set, because
712
1. only versioned entries can have executability under windows
713
2. only files can be executable. (The execute bit on a directory
714
does not indicate searchability)
717
for trans_id in self._new_executability:
718
if self.final_file_id(trans_id) is None:
719
conflicts.append(('unversioned executability', trans_id))
722
non_file = self.final_kind(trans_id) != "file"
726
conflicts.append(('non-file executability', trans_id))
729
def _overwrite_conflicts(self):
730
"""Check for overwrites (not permitted on Win32)"""
732
for trans_id in self._new_contents:
734
self.tree_kind(trans_id)
737
if trans_id not in self._removed_contents:
738
conflicts.append(('overwrite', trans_id,
739
self.final_name(trans_id)))
742
def _duplicate_entries(self, by_parent):
743
"""No directory may have two entries with the same name."""
745
if (self._new_name, self._new_parent) == ({}, {}):
747
for children in by_parent.itervalues():
748
name_ids = [(self.final_name(t), t) for t in children]
749
if not self._case_sensitive_target:
750
name_ids = [(n.lower(), t) for n, t in name_ids]
754
for name, trans_id in name_ids:
756
kind = self.final_kind(trans_id)
759
file_id = self.final_file_id(trans_id)
760
if kind is None and file_id is None:
762
if name == last_name:
763
conflicts.append(('duplicate', last_trans_id, trans_id,
766
last_trans_id = trans_id
769
def _duplicate_ids(self):
770
"""Each inventory id may only be used once"""
772
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
774
all_ids = self._tree.all_file_ids()
775
active_tree_ids = all_ids.difference(removed_tree_ids)
776
for trans_id, file_id in self._new_id.iteritems():
777
if file_id in active_tree_ids:
778
old_trans_id = self.trans_id_tree_file_id(file_id)
779
conflicts.append(('duplicate id', old_trans_id, trans_id))
782
def _parent_type_conflicts(self, by_parent):
783
"""parents must have directory 'contents'."""
785
for parent_id, children in by_parent.iteritems():
786
if parent_id is ROOT_PARENT:
788
if not self._any_contents(children):
790
for child in children:
792
self.final_kind(child)
796
kind = self.final_kind(parent_id)
800
conflicts.append(('missing parent', parent_id))
801
elif kind != "directory":
802
conflicts.append(('non-directory parent', parent_id))
805
def _any_contents(self, trans_ids):
806
"""Return true if any of the trans_ids, will have contents."""
807
for trans_id in trans_ids:
809
kind = self.final_kind(trans_id)
815
def _limbo_name(self, trans_id):
816
"""Generate the limbo name of a file"""
817
limbo_name = self._limbo_files.get(trans_id)
818
if limbo_name is not None:
820
parent = self._new_parent.get(trans_id)
821
# if the parent directory is already in limbo (e.g. when building a
822
# tree), choose a limbo name inside the parent, to reduce further
824
use_direct_path = False
825
if self._new_contents.get(parent) == 'directory':
826
filename = self._new_name.get(trans_id)
827
if filename is not None:
828
if parent not in self._limbo_children:
829
self._limbo_children[parent] = set()
830
self._limbo_children_names[parent] = {}
831
use_direct_path = True
832
# the direct path can only be used if no other file has
833
# already taken this pathname, i.e. if the name is unused, or
834
# if it is already associated with this trans_id.
835
elif self._case_sensitive_target:
836
if (self._limbo_children_names[parent].get(filename)
837
in (trans_id, None)):
838
use_direct_path = True
840
for l_filename, l_trans_id in\
841
self._limbo_children_names[parent].iteritems():
842
if l_trans_id == trans_id:
844
if l_filename.lower() == filename.lower():
847
use_direct_path = True
850
limbo_name = pathjoin(self._limbo_files[parent], filename)
851
self._limbo_children[parent].add(trans_id)
852
self._limbo_children_names[parent][filename] = trans_id
854
limbo_name = pathjoin(self._limbodir, trans_id)
855
self._needs_rename.add(trans_id)
856
self._limbo_files[trans_id] = limbo_name
859
def _set_executability(self, path, entry, trans_id):
860
"""Set the executability of versioned files """
861
new_executability = self._new_executability[trans_id]
862
entry.executable = new_executability
863
if supports_executable():
864
abspath = self._tree.abspath(path)
865
current_mode = os.stat(abspath).st_mode
866
if new_executability:
869
to_mode = current_mode | (0100 & ~umask)
870
# Enable x-bit for others only if they can read it.
871
if current_mode & 0004:
872
to_mode |= 0001 & ~umask
873
if current_mode & 0040:
874
to_mode |= 0010 & ~umask
876
to_mode = current_mode & ~0111
877
os.chmod(abspath, to_mode)
879
def _new_entry(self, name, parent_id, file_id):
880
"""Helper function to create a new filesystem entry."""
881
trans_id = self.create_path(name, parent_id)
882
if file_id is not None:
883
self.version_file(file_id, trans_id)
886
def new_file(self, name, parent_id, contents, file_id=None,
888
"""Convenience method to create files.
890
name is the name of the file to create.
891
parent_id is the transaction id of the parent directory of the file.
892
contents is an iterator of bytestrings, which will be used to produce
894
:param file_id: The inventory ID of the file, if it is to be versioned.
895
:param executable: Only valid when a file_id has been supplied.
897
trans_id = self._new_entry(name, parent_id, file_id)
898
# TODO: rather than scheduling a set_executable call,
899
# have create_file create the file with the right mode.
900
self.create_file(contents, trans_id)
901
if executable is not None:
902
self.set_executability(executable, trans_id)
905
def new_directory(self, name, parent_id, file_id=None):
906
"""Convenience method to create directories.
908
name is the name of the directory to create.
909
parent_id is the transaction id of the parent directory of the
911
file_id is the inventory ID of the directory, if it is to be versioned.
913
trans_id = self._new_entry(name, parent_id, file_id)
914
self.create_directory(trans_id)
917
def new_symlink(self, name, parent_id, target, file_id=None):
918
"""Convenience method to create symbolic link.
920
name is the name of the symlink to create.
921
parent_id is the transaction id of the parent directory of the symlink.
922
target is a bytestring of the target of the symlink.
923
file_id is the inventory ID of the file, if it is to be versioned.
925
trans_id = self._new_entry(name, parent_id, file_id)
926
self.create_symlink(target, trans_id)
929
def _affected_ids(self):
930
"""Return the set of transform ids affected by the transform"""
931
trans_ids = set(self._removed_id)
932
trans_ids.update(self._new_id.keys())
933
trans_ids.update(self._removed_contents)
934
trans_ids.update(self._new_contents.keys())
935
trans_ids.update(self._new_executability.keys())
936
trans_ids.update(self._new_name.keys())
937
trans_ids.update(self._new_parent.keys())
940
def _get_file_id_maps(self):
941
"""Return mapping of file_ids to trans_ids in the to and from states"""
942
trans_ids = self._affected_ids()
945
# Build up two dicts: trans_ids associated with file ids in the
946
# FROM state, vs the TO state.
947
for trans_id in trans_ids:
948
from_file_id = self.tree_file_id(trans_id)
949
if from_file_id is not None:
950
from_trans_ids[from_file_id] = trans_id
951
to_file_id = self.final_file_id(trans_id)
952
if to_file_id is not None:
953
to_trans_ids[to_file_id] = trans_id
954
return from_trans_ids, to_trans_ids
956
def _from_file_data(self, from_trans_id, from_versioned, file_id):
957
"""Get data about a file in the from (tree) state
959
Return a (name, parent, kind, executable) tuple
961
from_path = self._tree_id_paths.get(from_trans_id)
963
# get data from working tree if versioned
964
from_entry = self._tree.inventory[file_id]
965
from_name = from_entry.name
966
from_parent = from_entry.parent_id
969
if from_path is None:
970
# File does not exist in FROM state
974
# File exists, but is not versioned. Have to use path-
976
from_name = os.path.basename(from_path)
977
tree_parent = self.get_tree_parent(from_trans_id)
978
from_parent = self.tree_file_id(tree_parent)
979
if from_path is not None:
980
from_kind, from_executable, from_stats = \
981
self._tree._comparison_data(from_entry, from_path)
984
from_executable = False
985
return from_name, from_parent, from_kind, from_executable
987
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
988
"""Get data about a file in the to (target) state
990
Return a (name, parent, kind, executable) tuple
992
to_name = self.final_name(to_trans_id)
994
to_kind = self.final_kind(to_trans_id)
997
to_parent = self.final_file_id(self.final_parent(to_trans_id))
998
if to_trans_id in self._new_executability:
999
to_executable = self._new_executability[to_trans_id]
1000
elif to_trans_id == from_trans_id:
1001
to_executable = from_executable
1003
to_executable = False
1004
return to_name, to_parent, to_kind, to_executable
1006
def iter_changes(self):
1007
"""Produce output in the same format as Tree.iter_changes.
1009
Will produce nonsensical results if invoked while inventory/filesystem
1010
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1012
This reads the Transform, but only reproduces changes involving a
1013
file_id. Files that are not versioned in either of the FROM or TO
1014
states are not reflected.
1016
final_paths = FinalPaths(self)
1017
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1019
# Now iterate through all active file_ids
1020
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1022
from_trans_id = from_trans_ids.get(file_id)
1023
# find file ids, and determine versioning state
1024
if from_trans_id is None:
1025
from_versioned = False
1026
from_trans_id = to_trans_ids[file_id]
1028
from_versioned = True
1029
to_trans_id = to_trans_ids.get(file_id)
1030
if to_trans_id is None:
1031
to_versioned = False
1032
to_trans_id = from_trans_id
1036
from_name, from_parent, from_kind, from_executable = \
1037
self._from_file_data(from_trans_id, from_versioned, file_id)
1039
to_name, to_parent, to_kind, to_executable = \
1040
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1042
if not from_versioned:
1045
from_path = self._tree_id_paths.get(from_trans_id)
1046
if not to_versioned:
1049
to_path = final_paths.get_path(to_trans_id)
1050
if from_kind != to_kind:
1052
elif to_kind in ('file', 'symlink') and (
1053
to_trans_id != from_trans_id or
1054
to_trans_id in self._new_contents):
1056
if (not modified and from_versioned == to_versioned and
1057
from_parent==to_parent and from_name == to_name and
1058
from_executable == to_executable):
1060
results.append((file_id, (from_path, to_path), modified,
1061
(from_versioned, to_versioned),
1062
(from_parent, to_parent),
1063
(from_name, to_name),
1064
(from_kind, to_kind),
1065
(from_executable, to_executable)))
1066
return iter(sorted(results, key=lambda x:x[1]))
1068
def get_preview_tree(self):
1069
"""Return a tree representing the result of the transform.
1071
This tree only supports the subset of Tree functionality required
1072
by show_diff_trees. It must only be compared to tt._tree.
1074
return _PreviewTree(self)
1077
class TreeTransform(TreeTransformBase):
1078
"""Represent a tree transformation.
1080
This object is designed to support incremental generation of the transform,
1083
However, it gives optimum performance when parent directories are created
1084
before their contents. The transform is then able to put child files
1085
directly in their parent directory, avoiding later renames.
1087
It is easy to produce malformed transforms, but they are generally
1088
harmless. Attempting to apply a malformed transform will cause an
1089
exception to be raised before any modifications are made to the tree.
1091
Many kinds of malformed transforms can be corrected with the
1092
resolve_conflicts function. The remaining ones indicate programming error,
1093
such as trying to create a file with no path.
1095
Two sets of file creation methods are supplied. Convenience methods are:
1100
These are composed of the low-level methods:
1102
* create_file or create_directory or create_symlink
1106
Transform/Transaction ids
1107
-------------------------
1108
trans_ids are temporary ids assigned to all files involved in a transform.
1109
It's possible, even common, that not all files in the Tree have trans_ids.
1111
trans_ids are used because filenames and file_ids are not good enough
1112
identifiers; filenames change, and not all files have file_ids. File-ids
1113
are also associated with trans-ids, so that moving a file moves its
1116
trans_ids are only valid for the TreeTransform that generated them.
1120
Limbo is a temporary directory use to hold new versions of files.
1121
Files are added to limbo by create_file, create_directory, create_symlink,
1122
and their convenience variants (new_*). Files may be removed from limbo
1123
using cancel_creation. Files are renamed from limbo into their final
1124
location as part of TreeTransform.apply
1126
Limbo must be cleaned up, by either calling TreeTransform.apply or
1127
calling TreeTransform.finalize.
1129
Files are placed into limbo inside their parent directories, where
1130
possible. This reduces subsequent renames, and makes operations involving
1131
lots of files faster. This optimization is only possible if the parent
1132
directory is created *before* creating any of its children, so avoid
1133
creating children before parents, where possible.
1137
This temporary directory is used by _FileMover for storing files that are
1138
about to be deleted. In case of rollback, the files will be restored.
1139
FileMover does not delete files until it is sure that a rollback will not
1142
def __init__(self, tree, pb=DummyProgress()):
1143
"""Note: a tree_write lock is taken on the tree.
1145
Use TreeTransform.finalize() to release the lock (can be omitted if
1146
TreeTransform.apply() called).
1148
tree.lock_tree_write()
1151
control_files = tree._control_files
1152
limbodir = urlutils.local_path_from_url(
1153
control_files.controlfilename('limbo'))
1157
if e.errno == errno.EEXIST:
1158
raise ExistingLimbo(limbodir)
1159
deletiondir = urlutils.local_path_from_url(
1160
control_files.controlfilename('pending-deletion'))
1162
os.mkdir(deletiondir)
1164
if e.errno == errno.EEXIST:
1165
raise errors.ExistingPendingDeletion(deletiondir)
1170
TreeTransformBase.__init__(self, tree, limbodir, pb,
1171
tree.case_sensitive)
1172
self._deletiondir = deletiondir
1174
def apply(self, no_conflicts=False, _mover=None):
1175
"""Apply all changes to the inventory and filesystem.
1177
If filesystem or inventory conflicts are present, MalformedTransform
1180
If apply succeeds, finalize is not necessary.
1182
:param no_conflicts: if True, the caller guarantees there are no
1183
conflicts, so no check is made.
1184
:param _mover: Supply an alternate FileMover, for testing
1186
if not no_conflicts:
1187
conflicts = self.find_conflicts()
1188
if len(conflicts) != 0:
1189
raise MalformedTransform(conflicts=conflicts)
1190
inventory_delta = []
1191
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1194
mover = _FileMover()
1198
child_pb.update('Apply phase', 0, 2)
1199
self._apply_removals(inventory_delta, mover)
1200
child_pb.update('Apply phase', 1, 2)
1201
modified_paths = self._apply_insertions(inventory_delta, mover)
1206
mover.apply_deletions()
1209
self._tree.apply_inventory_delta(inventory_delta)
1212
return _TransformResults(modified_paths, self.rename_count)
1214
def _apply_removals(self, inventory_delta, mover):
1215
"""Perform tree operations that remove directory/inventory names.
1217
That is, delete files that are to be deleted, and put any files that
1218
need renaming into limbo. This must be done in strict child-to-parent
1221
tree_paths = list(self._tree_path_ids.iteritems())
1222
tree_paths.sort(reverse=True)
1223
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1225
for num, data in enumerate(tree_paths):
1226
path, trans_id = data
1227
child_pb.update('removing file', num, len(tree_paths))
1228
full_path = self._tree.abspath(path)
1229
if trans_id in self._removed_contents:
1230
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1232
elif trans_id in self._new_name or trans_id in \
1235
mover.rename(full_path, self._limbo_name(trans_id))
1237
if e.errno != errno.ENOENT:
1240
self.rename_count += 1
1241
if trans_id in self._removed_id:
1242
if trans_id == self._new_root:
1243
file_id = self._tree.get_root_id()
1245
file_id = self.tree_file_id(trans_id)
1246
assert file_id is not None
1247
# File-id isn't really being deleted, just moved
1248
if file_id in self._r_new_id:
1250
inventory_delta.append((path, None, file_id, None))
1254
def _apply_insertions(self, inventory_delta, mover):
1255
"""Perform tree operations that insert directory/inventory names.
1257
That is, create any files that need to be created, and restore from
1258
limbo any files that needed renaming. This must be done in strict
1259
parent-to-child order.
1261
new_paths = self.new_paths()
1263
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1266
for num, (path, trans_id) in enumerate(new_paths):
1268
child_pb.update('adding file', num, len(new_paths))
1269
if trans_id in self._new_contents or \
1270
self.path_changed(trans_id):
1271
full_path = self._tree.abspath(path)
1272
if trans_id in self._needs_rename:
1274
mover.rename(self._limbo_name(trans_id), full_path)
1276
# We may be renaming a dangling inventory id
1277
if e.errno != errno.ENOENT:
1280
self.rename_count += 1
1281
if trans_id in self._new_contents:
1282
modified_paths.append(full_path)
1283
completed_new.append(trans_id)
1284
file_id = self.final_file_id(trans_id)
1285
if file_id is not None and (trans_id in self._new_id or
1286
trans_id in self._new_name or trans_id in self._new_parent
1287
or trans_id in self._new_executability):
1289
kind = self.final_kind(trans_id)
1291
kind = self._tree.stored_kind(file_id)
1292
if trans_id in self._new_reference_revision:
1293
new_entry = inventory.TreeReference(
1294
self.final_file_id(trans_id),
1295
self._new_name[trans_id],
1296
self.final_file_id(self._new_parent[trans_id]),
1297
None, self._new_reference_revision[trans_id])
1299
new_entry = inventory.make_entry(kind,
1300
self.final_name(trans_id),
1301
self.final_file_id(self.final_parent(trans_id)),
1302
self.final_file_id(trans_id))
1304
old_path = self._tree.id2path(new_entry.file_id)
1305
except errors.NoSuchId:
1307
inventory_delta.append((old_path, path, new_entry.file_id,
1310
if trans_id in self._new_executability:
1311
self._set_executability(path, new_entry, trans_id)
1314
for trans_id in completed_new:
1315
del self._new_contents[trans_id]
1316
return modified_paths
1319
class TransformPreview(TreeTransformBase):
1320
"""A TreeTransform for generating preview trees.
1322
Unlike TreeTransform, this version works when the input tree is a
1323
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1324
unversioned files in the input tree.
1327
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1329
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1330
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1332
def canonical_path(self, path):
1335
def tree_kind(self, trans_id):
1336
path = self._tree_id_paths.get(trans_id)
1338
raise NoSuchFile(None)
1339
file_id = self._tree.path2id(path)
1340
return self._tree.kind(file_id)
1342
def _set_mode(self, trans_id, mode_id, typefunc):
1343
"""Set the mode of new file contents.
1344
The mode_id is the existing file to get the mode from (often the same
1345
as trans_id). The operation is only performed if there's a mode match
1346
according to typefunc.
1348
# is it ok to ignore this? probably
1351
def iter_tree_children(self, parent_id):
1352
"""Iterate through the entry's tree children, if any"""
1354
path = self._tree_id_paths[parent_id]
1357
file_id = self.tree_file_id(parent_id)
1358
for child in self._tree.inventory[file_id].children.iterkeys():
1359
childpath = joinpath(path, child)
1360
yield self.trans_id_tree_path(childpath)
1363
class _PreviewTree(object):
1364
"""Partial implementation of Tree to support show_diff_trees"""
1366
def __init__(self, transform):
1367
self._transform = transform
1369
def lock_read(self):
1370
# Perhaps in theory, this should lock the TreeTransform?
1376
def iter_changes(self, from_tree, include_unchanged=False,
1377
specific_files=None, pb=None, extra_trees=None,
1378
require_versioned=True, want_unversioned=False):
1379
"""See InterTree.iter_changes.
1381
This implementation does not support include_unchanged, specific_files,
1382
or want_unversioned. extra_trees, require_versioned, and pb are
1385
if from_tree is not self._transform._tree:
1386
raise ValueError('from_tree must be transform source tree.')
1387
if include_unchanged:
1388
raise ValueError('include_unchanged is not supported')
1389
if specific_files is not None:
1390
raise ValueError('specific_files is not supported')
1391
if want_unversioned:
1392
raise ValueError('want_unversioned is not supported')
1393
return self._transform.iter_changes()
1395
def kind(self, file_id):
1396
trans_id = self._transform.trans_id_file_id(file_id)
1397
return self._transform.final_kind(trans_id)
1399
def get_file_mtime(self, file_id, path=None):
1400
"""See Tree.get_file_mtime"""
1401
trans_id = self._transform.trans_id_file_id(file_id)
1402
name = self._transform._limbo_name(trans_id)
1403
return os.stat(name).st_mtime
1405
def get_file(self, file_id):
1406
"""See Tree.get_file"""
1407
trans_id = self._transform.trans_id_file_id(file_id)
1408
name = self._transform._limbo_name(trans_id)
1409
return open(name, 'rb')
1411
def get_symlink_target(self, file_id):
1412
"""See Tree.get_symlink_target"""
1413
trans_id = self._transform.trans_id_file_id(file_id)
1414
name = self._transform._limbo_name(trans_id)
1415
return os.readlink(name)
1417
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1418
"""See Tree.paths2ids"""
1422
def joinpath(parent, child):
1423
"""Join tree-relative paths, handling the tree root specially"""
1424
if parent is None or parent == "":
1427
return pathjoin(parent, child)
1430
class FinalPaths(object):
1431
"""Make path calculation cheap by memoizing paths.
1433
The underlying tree must not be manipulated between calls, or else
1434
the results will likely be incorrect.
1436
def __init__(self, transform):
1437
object.__init__(self)
1438
self._known_paths = {}
1439
self.transform = transform
1441
def _determine_path(self, trans_id):
1442
if trans_id == self.transform.root:
1444
name = self.transform.final_name(trans_id)
1445
parent_id = self.transform.final_parent(trans_id)
1446
if parent_id == self.transform.root:
1449
return pathjoin(self.get_path(parent_id), name)
1451
def get_path(self, trans_id):
1452
"""Find the final path associated with a trans_id"""
1453
if trans_id not in self._known_paths:
1454
self._known_paths[trans_id] = self._determine_path(trans_id)
1455
return self._known_paths[trans_id]
1458
def topology_sorted_ids(tree):
1459
"""Determine the topological order of the ids in a tree"""
1460
file_ids = list(tree)
1461
file_ids.sort(key=tree.id2path)
1465
def build_tree(tree, wt, accelerator_tree=None, hardlink=False):
1466
"""Create working tree for a branch, using a TreeTransform.
1468
This function should be used on empty trees, having a tree root at most.
1469
(see merge and revert functionality for working with existing trees)
1471
Existing files are handled like so:
1473
- Existing bzrdirs take precedence over creating new items. They are
1474
created as '%s.diverted' % name.
1475
- Otherwise, if the content on disk matches the content we are building,
1476
it is silently replaced.
1477
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1479
:param tree: The tree to convert wt into a copy of
1480
:param wt: The working tree that files will be placed into
1481
:param accelerator_tree: A tree which can be used for retrieving file
1482
contents more quickly than tree itself, i.e. a workingtree. tree
1483
will be used for cases where accelerator_tree's content is different.
1484
:param hardlink: If true, hard-link files to accelerator_tree, where
1485
possible. accelerator_tree must implement abspath, i.e. be a
1488
wt.lock_tree_write()
1492
if accelerator_tree is not None:
1493
accelerator_tree.lock_read()
1495
return _build_tree(tree, wt, accelerator_tree, hardlink)
1497
if accelerator_tree is not None:
1498
accelerator_tree.unlock()
1505
def _build_tree(tree, wt, accelerator_tree, hardlink):
1506
"""See build_tree."""
1507
for num, _unused in enumerate(wt.all_file_ids()):
1508
if num > 0: # more than just a root
1509
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1511
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1512
pp = ProgressPhase("Build phase", 2, top_pb)
1513
if tree.inventory.root is not None:
1514
# This is kind of a hack: we should be altering the root
1515
# as part of the regular tree shape diff logic.
1516
# The conditional test here is to avoid doing an
1517
# expensive operation (flush) every time the root id
1518
# is set within the tree, nor setting the root and thus
1519
# marking the tree as dirty, because we use two different
1520
# idioms here: tree interfaces and inventory interfaces.
1521
if wt.get_root_id() != tree.get_root_id():
1522
wt.set_root_id(tree.get_root_id())
1524
tt = TreeTransform(wt)
1528
file_trans_id[wt.get_root_id()] = \
1529
tt.trans_id_tree_file_id(wt.get_root_id())
1530
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1532
deferred_contents = []
1534
for num, (tree_path, entry) in \
1535
enumerate(tree.inventory.iter_entries_by_dir()):
1536
pb.update("Building tree", num - len(deferred_contents),
1537
len(tree.inventory))
1538
if entry.parent_id is None:
1541
file_id = entry.file_id
1542
target_path = wt.abspath(tree_path)
1544
kind = file_kind(target_path)
1548
if kind == "directory":
1550
bzrdir.BzrDir.open(target_path)
1551
except errors.NotBranchError:
1555
if (file_id not in divert and
1556
_content_match(tree, entry, file_id, kind,
1558
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1559
if kind == 'directory':
1561
if entry.parent_id not in file_trans_id:
1562
raise AssertionError(
1563
'entry %s parent id %r is not in file_trans_id %r'
1564
% (entry, entry.parent_id, file_trans_id))
1565
parent_id = file_trans_id[entry.parent_id]
1566
if entry.kind == 'file':
1567
# We *almost* replicate new_by_entry, so that we can defer
1568
# getting the file text, and get them all at once.
1569
trans_id = tt.create_path(entry.name, parent_id)
1570
file_trans_id[file_id] = trans_id
1571
tt.version_file(entry.file_id, trans_id)
1572
executable = tree.is_executable(entry.file_id, tree_path)
1573
if executable is not None:
1574
tt.set_executability(executable, trans_id)
1575
deferred_contents.append((entry.file_id, trans_id))
1577
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1580
new_trans_id = file_trans_id[file_id]
1581
old_parent = tt.trans_id_tree_path(tree_path)
1582
_reparent_children(tt, old_parent, new_trans_id)
1583
offset = num + 1 - len(deferred_contents)
1584
_create_files(tt, tree, deferred_contents, pb, offset,
1585
accelerator_tree, hardlink)
1589
divert_trans = set(file_trans_id[f] for f in divert)
1590
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1591
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1592
conflicts = cook_conflicts(raw_conflicts, tt)
1593
for conflict in conflicts:
1596
wt.add_conflicts(conflicts)
1597
except errors.UnsupportedOperation:
1599
result = tt.apply(no_conflicts=True)
1606
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1608
total = len(desired_files) + offset
1609
if accelerator_tree is None:
1610
new_desired_files = desired_files
1612
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1613
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1614
in iter if not (c or e[0] != e[1]))
1615
new_desired_files = []
1617
for file_id, trans_id in desired_files:
1618
accelerator_path = unchanged.get(file_id)
1619
if accelerator_path is None:
1620
new_desired_files.append((file_id, trans_id))
1622
pb.update('Adding file contents', count + offset, total)
1624
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1627
contents = accelerator_tree.get_file(file_id, accelerator_path)
1629
tt.create_file(contents, trans_id)
1634
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1635
new_desired_files)):
1636
tt.create_file(contents, trans_id)
1637
pb.update('Adding file contents', count + offset, total)
1640
def _reparent_children(tt, old_parent, new_parent):
1641
for child in tt.iter_tree_children(old_parent):
1642
tt.adjust_path(tt.final_name(child), new_parent, child)
1644
def _reparent_transform_children(tt, old_parent, new_parent):
1645
by_parent = tt.by_parent()
1646
for child in by_parent[old_parent]:
1647
tt.adjust_path(tt.final_name(child), new_parent, child)
1648
return by_parent[old_parent]
1650
def _content_match(tree, entry, file_id, kind, target_path):
1651
if entry.kind != kind:
1653
if entry.kind == "directory":
1655
if entry.kind == "file":
1656
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1658
elif entry.kind == "symlink":
1659
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1664
def resolve_checkout(tt, conflicts, divert):
1665
new_conflicts = set()
1666
for c_type, conflict in ((c[0], c) for c in conflicts):
1667
# Anything but a 'duplicate' would indicate programmer error
1668
assert c_type == 'duplicate', c_type
1669
# Now figure out which is new and which is old
1670
if tt.new_contents(conflict[1]):
1671
new_file = conflict[1]
1672
old_file = conflict[2]
1674
new_file = conflict[2]
1675
old_file = conflict[1]
1677
# We should only get here if the conflict wasn't completely
1679
final_parent = tt.final_parent(old_file)
1680
if new_file in divert:
1681
new_name = tt.final_name(old_file)+'.diverted'
1682
tt.adjust_path(new_name, final_parent, new_file)
1683
new_conflicts.add((c_type, 'Diverted to',
1684
new_file, old_file))
1686
new_name = tt.final_name(old_file)+'.moved'
1687
tt.adjust_path(new_name, final_parent, old_file)
1688
new_conflicts.add((c_type, 'Moved existing file to',
1689
old_file, new_file))
1690
return new_conflicts
1693
def new_by_entry(tt, entry, parent_id, tree):
1694
"""Create a new file according to its inventory entry"""
1698
contents = tree.get_file(entry.file_id).readlines()
1699
executable = tree.is_executable(entry.file_id)
1700
return tt.new_file(name, parent_id, contents, entry.file_id,
1702
elif kind in ('directory', 'tree-reference'):
1703
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1704
if kind == 'tree-reference':
1705
tt.set_tree_reference(entry.reference_revision, trans_id)
1707
elif kind == 'symlink':
1708
target = tree.get_symlink_target(entry.file_id)
1709
return tt.new_symlink(name, parent_id, target, entry.file_id)
1711
raise errors.BadFileKindError(name, kind)
1714
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1715
"""Create new file contents according to an inventory entry."""
1716
if entry.kind == "file":
1718
lines = tree.get_file(entry.file_id).readlines()
1719
tt.create_file(lines, trans_id, mode_id=mode_id)
1720
elif entry.kind == "symlink":
1721
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1722
elif entry.kind == "directory":
1723
tt.create_directory(trans_id)
1726
def create_entry_executability(tt, entry, trans_id):
1727
"""Set the executability of a trans_id according to an inventory entry"""
1728
if entry.kind == "file":
1729
tt.set_executability(entry.executable, trans_id)
1732
@deprecated_function(zero_fifteen)
1733
def find_interesting(working_tree, target_tree, filenames):
1734
"""Find the ids corresponding to specified filenames.
1736
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1738
working_tree.lock_read()
1740
target_tree.lock_read()
1742
return working_tree.paths2ids(filenames, [target_tree])
1744
target_tree.unlock()
1746
working_tree.unlock()
1749
@deprecated_function(zero_ninety)
1750
def change_entry(tt, file_id, working_tree, target_tree,
1751
trans_id_file_id, backups, trans_id, by_parent):
1752
"""Replace a file_id's contents with those from a target tree."""
1753
if file_id is None and target_tree is None:
1754
# skip the logic altogether in the deprecation test
1756
e_trans_id = trans_id_file_id(file_id)
1757
entry = target_tree.inventory[file_id]
1758
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1761
mode_id = e_trans_id
1764
tt.delete_contents(e_trans_id)
1766
parent_trans_id = trans_id_file_id(entry.parent_id)
1767
backup_name = get_backup_name(entry, by_parent,
1768
parent_trans_id, tt)
1769
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1770
tt.unversion_file(e_trans_id)
1771
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1772
tt.version_file(file_id, e_trans_id)
1773
trans_id[file_id] = e_trans_id
1774
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1775
create_entry_executability(tt, entry, e_trans_id)
1778
tt.set_executability(entry.executable, e_trans_id)
1779
if tt.final_name(e_trans_id) != entry.name:
1782
parent_id = tt.final_parent(e_trans_id)
1783
parent_file_id = tt.final_file_id(parent_id)
1784
if parent_file_id != entry.parent_id:
1789
parent_trans_id = trans_id_file_id(entry.parent_id)
1790
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1793
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1794
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1797
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1798
"""Produce a backup-style name that appears to be available"""
1802
yield "%s.~%d~" % (name, counter)
1804
for new_name in name_gen():
1805
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1809
def _entry_changes(file_id, entry, working_tree):
1810
"""Determine in which ways the inventory entry has changed.
1812
Returns booleans: has_contents, content_mod, meta_mod
1813
has_contents means there are currently contents, but they differ
1814
contents_mod means contents need to be modified
1815
meta_mod means the metadata needs to be modified
1817
cur_entry = working_tree.inventory[file_id]
1819
working_kind = working_tree.kind(file_id)
1822
has_contents = False
1825
if has_contents is True:
1826
if entry.kind != working_kind:
1827
contents_mod, meta_mod = True, False
1829
cur_entry._read_tree_state(working_tree.id2path(file_id),
1831
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1832
cur_entry._forget_tree_state()
1833
return has_contents, contents_mod, meta_mod
1836
def revert(working_tree, target_tree, filenames, backups=False,
1837
pb=DummyProgress(), change_reporter=None):
1838
"""Revert a working tree's contents to those of a target tree."""
1839
target_tree.lock_read()
1840
tt = TreeTransform(working_tree, pb)
1842
pp = ProgressPhase("Revert phase", 3, pb)
1844
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1846
merge_modified = _alter_files(working_tree, target_tree, tt,
1847
child_pb, filenames, backups)
1851
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1853
raw_conflicts = resolve_conflicts(tt, child_pb,
1854
lambda t, c: conflict_pass(t, c, target_tree))
1857
conflicts = cook_conflicts(raw_conflicts, tt)
1859
change_reporter = delta._ChangeReporter(
1860
unversioned_filter=working_tree.is_ignored)
1861
delta.report_changes(tt.iter_changes(), change_reporter)
1862
for conflict in conflicts:
1866
working_tree.set_merge_modified(merge_modified)
1868
target_tree.unlock()
1874
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1876
merge_modified = working_tree.merge_modified()
1877
change_list = target_tree.iter_changes(working_tree,
1878
specific_files=specific_files, pb=pb)
1879
if target_tree.inventory.root is None:
1886
for id_num, (file_id, path, changed_content, versioned, parent, name,
1887
kind, executable) in enumerate(change_list):
1888
if skip_root and file_id[0] is not None and parent[0] is None:
1890
trans_id = tt.trans_id_file_id(file_id)
1893
keep_content = False
1894
if kind[0] == 'file' and (backups or kind[1] is None):
1895
wt_sha1 = working_tree.get_file_sha1(file_id)
1896
if merge_modified.get(file_id) != wt_sha1:
1897
# acquire the basis tree lazily to prevent the
1898
# expense of accessing it when it's not needed ?
1899
# (Guessing, RBC, 200702)
1900
if basis_tree is None:
1901
basis_tree = working_tree.basis_tree()
1902
basis_tree.lock_read()
1903
if file_id in basis_tree:
1904
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1906
elif kind[1] is None and not versioned[1]:
1908
if kind[0] is not None:
1909
if not keep_content:
1910
tt.delete_contents(trans_id)
1911
elif kind[1] is not None:
1912
parent_trans_id = tt.trans_id_file_id(parent[0])
1913
by_parent = tt.by_parent()
1914
backup_name = _get_backup_name(name[0], by_parent,
1915
parent_trans_id, tt)
1916
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1917
new_trans_id = tt.create_path(name[0], parent_trans_id)
1918
if versioned == (True, True):
1919
tt.unversion_file(trans_id)
1920
tt.version_file(file_id, new_trans_id)
1921
# New contents should have the same unix perms as old
1924
trans_id = new_trans_id
1925
if kind[1] == 'directory':
1926
tt.create_directory(trans_id)
1927
elif kind[1] == 'symlink':
1928
tt.create_symlink(target_tree.get_symlink_target(file_id),
1930
elif kind[1] == 'file':
1931
deferred_files.append((file_id, (trans_id, mode_id)))
1932
if basis_tree is None:
1933
basis_tree = working_tree.basis_tree()
1934
basis_tree.lock_read()
1935
new_sha1 = target_tree.get_file_sha1(file_id)
1936
if (file_id in basis_tree and new_sha1 ==
1937
basis_tree.get_file_sha1(file_id)):
1938
if file_id in merge_modified:
1939
del merge_modified[file_id]
1941
merge_modified[file_id] = new_sha1
1943
# preserve the execute bit when backing up
1944
if keep_content and executable[0] == executable[1]:
1945
tt.set_executability(executable[1], trans_id)
1947
assert kind[1] is None
1948
if versioned == (False, True):
1949
tt.version_file(file_id, trans_id)
1950
if versioned == (True, False):
1951
tt.unversion_file(trans_id)
1952
if (name[1] is not None and
1953
(name[0] != name[1] or parent[0] != parent[1])):
1955
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1956
if executable[0] != executable[1] and kind[1] == "file":
1957
tt.set_executability(executable[1], trans_id)
1958
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1960
tt.create_file(bytes, trans_id, mode_id)
1962
if basis_tree is not None:
1964
return merge_modified
1967
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1968
"""Make many conflict-resolution attempts, but die if they fail"""
1969
if pass_func is None:
1970
pass_func = conflict_pass
1971
new_conflicts = set()
1974
pb.update('Resolution pass', n+1, 10)
1975
conflicts = tt.find_conflicts()
1976
if len(conflicts) == 0:
1977
return new_conflicts
1978
new_conflicts.update(pass_func(tt, conflicts))
1979
raise MalformedTransform(conflicts=conflicts)
1984
def conflict_pass(tt, conflicts, path_tree=None):
1985
"""Resolve some classes of conflicts.
1987
:param tt: The transform to resolve conflicts in
1988
:param conflicts: The conflicts to resolve
1989
:param path_tree: A Tree to get supplemental paths from
1991
new_conflicts = set()
1992
for c_type, conflict in ((c[0], c) for c in conflicts):
1993
if c_type == 'duplicate id':
1994
tt.unversion_file(conflict[1])
1995
new_conflicts.add((c_type, 'Unversioned existing file',
1996
conflict[1], conflict[2], ))
1997
elif c_type == 'duplicate':
1998
# files that were renamed take precedence
1999
final_parent = tt.final_parent(conflict[1])
2000
if tt.path_changed(conflict[1]):
2001
existing_file, new_file = conflict[2], conflict[1]
2003
existing_file, new_file = conflict[1], conflict[2]
2004
new_name = tt.final_name(existing_file)+'.moved'
2005
tt.adjust_path(new_name, final_parent, existing_file)
2006
new_conflicts.add((c_type, 'Moved existing file to',
2007
existing_file, new_file))
2008
elif c_type == 'parent loop':
2009
# break the loop by undoing one of the ops that caused the loop
2011
while not tt.path_changed(cur):
2012
cur = tt.final_parent(cur)
2013
new_conflicts.add((c_type, 'Cancelled move', cur,
2014
tt.final_parent(cur),))
2015
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2017
elif c_type == 'missing parent':
2018
trans_id = conflict[1]
2020
tt.cancel_deletion(trans_id)
2021
new_conflicts.add(('deleting parent', 'Not deleting',
2026
tt.final_name(trans_id)
2028
if path_tree is not None:
2029
file_id = tt.final_file_id(trans_id)
2031
file_id = tt.inactive_file_id(trans_id)
2032
entry = path_tree.inventory[file_id]
2033
# special-case the other tree root (move its
2034
# children to current root)
2035
if entry.parent_id is None:
2037
moved = _reparent_transform_children(
2038
tt, trans_id, tt.root)
2040
new_conflicts.add((c_type, 'Moved to root',
2043
parent_trans_id = tt.trans_id_file_id(
2045
tt.adjust_path(entry.name, parent_trans_id,
2048
tt.create_directory(trans_id)
2049
new_conflicts.add((c_type, 'Created directory', trans_id))
2050
elif c_type == 'unversioned parent':
2051
file_id = tt.inactive_file_id(conflict[1])
2052
# special-case the other tree root (move its children instead)
2053
if path_tree and file_id in path_tree:
2054
if path_tree.inventory[file_id].parent_id is None:
2056
tt.version_file(file_id, conflict[1])
2057
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2058
elif c_type == 'non-directory parent':
2059
parent_id = conflict[1]
2060
parent_parent = tt.final_parent(parent_id)
2061
parent_name = tt.final_name(parent_id)
2062
parent_file_id = tt.final_file_id(parent_id)
2063
new_parent_id = tt.new_directory(parent_name + '.new',
2064
parent_parent, parent_file_id)
2065
_reparent_transform_children(tt, parent_id, new_parent_id)
2066
if parent_file_id is not None:
2067
tt.unversion_file(parent_id)
2068
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2069
return new_conflicts
2072
def cook_conflicts(raw_conflicts, tt):
2073
"""Generate a list of cooked conflicts, sorted by file path"""
2074
from bzrlib.conflicts import Conflict
2075
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2076
return sorted(conflict_iter, key=Conflict.sort_key)
2079
def iter_cook_conflicts(raw_conflicts, tt):
2080
from bzrlib.conflicts import Conflict
2082
for conflict in raw_conflicts:
2083
c_type = conflict[0]
2084
action = conflict[1]
2085
modified_path = fp.get_path(conflict[2])
2086
modified_id = tt.final_file_id(conflict[2])
2087
if len(conflict) == 3:
2088
yield Conflict.factory(c_type, action=action, path=modified_path,
2089
file_id=modified_id)
2092
conflicting_path = fp.get_path(conflict[3])
2093
conflicting_id = tt.final_file_id(conflict[3])
2094
yield Conflict.factory(c_type, action=action, path=modified_path,
2095
file_id=modified_id,
2096
conflict_path=conflicting_path,
2097
conflict_file_id=conflicting_id)
2100
class _FileMover(object):
2101
"""Moves and deletes files for TreeTransform, tracking operations"""
2104
self.past_renames = []
2105
self.pending_deletions = []
2107
def rename(self, from_, to):
2108
"""Rename a file from one path to another. Functions like os.rename"""
2110
os.rename(from_, to)
2112
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2113
raise errors.FileExists(to, str(e))
2115
self.past_renames.append((from_, to))
2117
def pre_delete(self, from_, to):
2118
"""Rename a file out of the way and mark it for deletion.
2120
Unlike os.unlink, this works equally well for files and directories.
2121
:param from_: The current file path
2122
:param to: A temporary path for the file
2124
self.rename(from_, to)
2125
self.pending_deletions.append(to)
2128
"""Reverse all renames that have been performed"""
2129
for from_, to in reversed(self.past_renames):
2130
os.rename(to, from_)
2131
# after rollback, don't reuse _FileMover
2133
pending_deletions = None
2135
def apply_deletions(self):
2136
"""Apply all marked deletions"""
2137
for path in self.pending_deletions:
2139
# after apply_deletions, don't reuse _FileMover
2141
pending_deletions = None
added
removed
bzrlib/transform.py
