1
# Copyright (C) 2006, 2007 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
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
30
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
31
ReusingTransform, NotVersionedError, CantMoveRoot,
32
ExistingLimbo, ImmortalLimbo, NoFinalPath,
34
from bzrlib.inventory import InventoryEntry
35
from bzrlib.osutils import (file_kind, supports_executable, pathjoin, lexists,
36
delete_any, has_symlinks)
37
from bzrlib.progress import DummyProgress, ProgressPhase
38
from bzrlib.symbol_versioning import (
43
from bzrlib.trace import mutter, warning
44
from bzrlib import tree
46
import bzrlib.urlutils as urlutils
49
ROOT_PARENT = "root-parent"
52
def unique_add(map, key, value):
54
raise DuplicateKey(key=key)
58
class _TransformResults(object):
59
def __init__(self, modified_paths, rename_count):
61
self.modified_paths = modified_paths
62
self.rename_count = rename_count
65
class TreeTransform(object):
66
"""Represent a tree transformation.
68
This object is designed to support incremental generation of the transform,
71
However, it gives optimum performance when parent directories are created
72
before their contents. The transform is then able to put child files
73
directly in their parent directory, avoiding later renames.
75
It is easy to produce malformed transforms, but they are generally
76
harmless. Attempting to apply a malformed transform will cause an
77
exception to be raised before any modifications are made to the tree.
79
Many kinds of malformed transforms can be corrected with the
80
resolve_conflicts function. The remaining ones indicate programming error,
81
such as trying to create a file with no path.
83
Two sets of file creation methods are supplied. Convenience methods are:
88
These are composed of the low-level methods:
90
* create_file or create_directory or create_symlink
94
Transform/Transaction ids
95
-------------------------
96
trans_ids are temporary ids assigned to all files involved in a transform.
97
It's possible, even common, that not all files in the Tree have trans_ids.
99
trans_ids are used because filenames and file_ids are not good enough
100
identifiers; filenames change, and not all files have file_ids. File-ids
101
are also associated with trans-ids, so that moving a file moves its
104
trans_ids are only valid for the TreeTransform that generated them.
108
Limbo is a temporary directory use to hold new versions of files.
109
Files are added to limbo by create_file, create_directory, create_symlink,
110
and their convenience variants (new_*). Files may be removed from limbo
111
using cancel_creation. Files are renamed from limbo into their final
112
location as part of TreeTransform.apply
114
Limbo must be cleaned up, by either calling TreeTransform.apply or
115
calling TreeTransform.finalize.
117
Files are placed into limbo inside their parent directories, where
118
possible. This reduces subsequent renames, and makes operations involving
119
lots of files faster. This optimization is only possible if the parent
120
directory is created *before* creating any of its children, so avoid
121
creating children before parents, where possible.
125
This temporary directory is used by _FileMover for storing files that are
126
about to be deleted. In case of rollback, the files will be restored.
127
FileMover does not delete files until it is sure that a rollback will not
130
def __init__(self, tree, pb=DummyProgress()):
131
"""Note: a tree_write lock is taken on the tree.
133
Use TreeTransform.finalize() to release the lock (can be omitted if
134
TreeTransform.apply() called).
136
object.__init__(self)
138
self._tree.lock_tree_write()
140
control_files = self._tree._control_files
141
self._limbodir = urlutils.local_path_from_url(
142
control_files.controlfilename('limbo'))
144
os.mkdir(self._limbodir)
146
if e.errno == errno.EEXIST:
147
raise ExistingLimbo(self._limbodir)
148
self._deletiondir = urlutils.local_path_from_url(
149
control_files.controlfilename('pending-deletion'))
151
os.mkdir(self._deletiondir)
153
if e.errno == errno.EEXIST:
154
raise errors.ExistingPendingDeletion(self._deletiondir)
160
# counter used to generate trans-ids (which are locally unique)
162
# mapping of trans_id -> new basename
164
# mapping of trans_id -> new parent trans_id
165
self._new_parent = {}
166
# mapping of trans_id with new contents -> new file_kind
167
self._new_contents = {}
168
# A mapping of transform ids to their limbo filename
169
self._limbo_files = {}
170
# A mapping of transform ids to a set of the transform ids of children
171
# that their limbo directory has
172
self._limbo_children = {}
173
# Map transform ids to maps of child filename to child transform id
174
self._limbo_children_names = {}
175
# List of transform ids that need to be renamed from limbo into place
176
self._needs_rename = set()
177
# Set of trans_ids whose contents will be removed
178
self._removed_contents = set()
179
# Mapping of trans_id -> new execute-bit value
180
self._new_executability = {}
181
# Mapping of trans_id -> new tree-reference value
182
self._new_reference_revision = {}
183
# Mapping of trans_id -> new file_id
185
# Mapping of old file-id -> trans_id
186
self._non_present_ids = {}
187
# Mapping of new file_id -> trans_id
189
# Set of file_ids that will be removed
190
self._removed_id = set()
191
# Mapping of path in old tree -> trans_id
192
self._tree_path_ids = {}
193
# Mapping trans_id -> path in old tree
194
self._tree_id_paths = {}
195
# Cache of realpath results, to speed up canonical_path
197
# Cache of relpath results, to speed up canonical_path
199
# The trans_id that will be used as the tree root
200
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
201
# Indictor of whether the transform has been applied
205
# A counter of how many files have been renamed
206
self.rename_count = 0
208
def __get_root(self):
209
return self._new_root
211
root = property(__get_root)
214
"""Release the working tree lock, if held, clean up limbo dir.
216
This is required if apply has not been invoked, but can be invoked
219
if self._tree is None:
222
entries = [(self._limbo_name(t), t, k) for t, k in
223
self._new_contents.iteritems()]
224
entries.sort(reverse=True)
225
for path, trans_id, kind in entries:
226
if kind == "directory":
231
os.rmdir(self._limbodir)
233
# We don't especially care *why* the dir is immortal.
234
raise ImmortalLimbo(self._limbodir)
236
os.rmdir(self._deletiondir)
238
raise errors.ImmortalPendingDeletion(self._deletiondir)
243
def _assign_id(self):
244
"""Produce a new tranform id"""
245
new_id = "new-%s" % self._id_number
249
def create_path(self, name, parent):
250
"""Assign a transaction id to a new path"""
251
trans_id = self._assign_id()
252
unique_add(self._new_name, trans_id, name)
253
unique_add(self._new_parent, trans_id, parent)
256
def adjust_path(self, name, parent, trans_id):
257
"""Change the path that is assigned to a transaction id."""
258
if trans_id == self._new_root:
260
previous_parent = self._new_parent.get(trans_id)
261
previous_name = self._new_name.get(trans_id)
262
self._new_name[trans_id] = name
263
self._new_parent[trans_id] = parent
264
if (trans_id in self._limbo_files and
265
trans_id not in self._needs_rename):
266
self._rename_in_limbo([trans_id])
267
self._limbo_children[previous_parent].remove(trans_id)
268
del self._limbo_children_names[previous_parent][previous_name]
270
def _rename_in_limbo(self, trans_ids):
271
"""Fix limbo names so that the right final path is produced.
273
This means we outsmarted ourselves-- we tried to avoid renaming
274
these files later by creating them with their final names in their
275
final parents. But now the previous name or parent is no longer
276
suitable, so we have to rename them.
278
Even for trans_ids that have no new contents, we must remove their
279
entries from _limbo_files, because they are now stale.
281
for trans_id in trans_ids:
282
old_path = self._limbo_files.pop(trans_id)
283
if trans_id not in self._new_contents:
285
new_path = self._limbo_name(trans_id)
286
os.rename(old_path, new_path)
288
def adjust_root_path(self, name, parent):
289
"""Emulate moving the root by moving all children, instead.
291
We do this by undoing the association of root's transaction id with the
292
current tree. This allows us to create a new directory with that
293
transaction id. We unversion the root directory and version the
294
physically new directory, and hope someone versions the tree root
297
old_root = self._new_root
298
old_root_file_id = self.final_file_id(old_root)
299
# force moving all children of root
300
for child_id in self.iter_tree_children(old_root):
301
if child_id != parent:
302
self.adjust_path(self.final_name(child_id),
303
self.final_parent(child_id), child_id)
304
file_id = self.final_file_id(child_id)
305
if file_id is not None:
306
self.unversion_file(child_id)
307
self.version_file(file_id, child_id)
309
# the physical root needs a new transaction id
310
self._tree_path_ids.pop("")
311
self._tree_id_paths.pop(old_root)
312
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
313
if parent == old_root:
314
parent = self._new_root
315
self.adjust_path(name, parent, old_root)
316
self.create_directory(old_root)
317
self.version_file(old_root_file_id, old_root)
318
self.unversion_file(self._new_root)
320
def trans_id_tree_file_id(self, inventory_id):
321
"""Determine the transaction id of a working tree file.
323
This reflects only files that already exist, not ones that will be
324
added by transactions.
326
path = self._tree.inventory.id2path(inventory_id)
327
return self.trans_id_tree_path(path)
329
def trans_id_file_id(self, file_id):
330
"""Determine or set the transaction id associated with a file ID.
331
A new id is only created for file_ids that were never present. If
332
a transaction has been unversioned, it is deliberately still returned.
333
(this will likely lead to an unversioned parent conflict.)
335
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
336
return self._r_new_id[file_id]
337
elif file_id in self._tree.inventory:
338
return self.trans_id_tree_file_id(file_id)
339
elif file_id in self._non_present_ids:
340
return self._non_present_ids[file_id]
342
trans_id = self._assign_id()
343
self._non_present_ids[file_id] = trans_id
346
def canonical_path(self, path):
347
"""Get the canonical tree-relative path"""
348
# don't follow final symlinks
349
abs = self._tree.abspath(path)
350
if abs in self._relpaths:
351
return self._relpaths[abs]
352
dirname, basename = os.path.split(abs)
353
if dirname not in self._realpaths:
354
self._realpaths[dirname] = os.path.realpath(dirname)
355
dirname = self._realpaths[dirname]
356
abs = pathjoin(dirname, basename)
357
if dirname in self._relpaths:
358
relpath = pathjoin(self._relpaths[dirname], basename)
359
relpath = relpath.rstrip('/\\')
361
relpath = self._tree.relpath(abs)
362
self._relpaths[abs] = relpath
365
def trans_id_tree_path(self, path):
366
"""Determine (and maybe set) the transaction ID for a tree path."""
367
path = self.canonical_path(path)
368
if path not in self._tree_path_ids:
369
self._tree_path_ids[path] = self._assign_id()
370
self._tree_id_paths[self._tree_path_ids[path]] = path
371
return self._tree_path_ids[path]
373
def get_tree_parent(self, trans_id):
374
"""Determine id of the parent in the tree."""
375
path = self._tree_id_paths[trans_id]
378
return self.trans_id_tree_path(os.path.dirname(path))
380
def create_file(self, contents, trans_id, mode_id=None):
381
"""Schedule creation of a new file.
385
Contents is an iterator of strings, all of which will be written
386
to the target destination.
388
New file takes the permissions of any existing file with that id,
389
unless mode_id is specified.
391
name = self._limbo_name(trans_id)
395
unique_add(self._new_contents, trans_id, 'file')
397
# Clean up the file, it never got registered so
398
# TreeTransform.finalize() won't clean it up.
403
f.writelines(contents)
406
self._set_mode(trans_id, mode_id, S_ISREG)
408
def _set_mode(self, trans_id, mode_id, typefunc):
409
"""Set the mode of new file contents.
410
The mode_id is the existing file to get the mode from (often the same
411
as trans_id). The operation is only performed if there's a mode match
412
according to typefunc.
417
old_path = self._tree_id_paths[mode_id]
421
mode = os.stat(self._tree.abspath(old_path)).st_mode
423
if e.errno == errno.ENOENT:
428
os.chmod(self._limbo_name(trans_id), mode)
430
def create_directory(self, trans_id):
431
"""Schedule creation of a new directory.
433
See also new_directory.
435
os.mkdir(self._limbo_name(trans_id))
436
unique_add(self._new_contents, trans_id, 'directory')
438
def create_symlink(self, target, trans_id):
439
"""Schedule creation of a new symbolic link.
441
target is a bytestring.
442
See also new_symlink.
445
os.symlink(target, self._limbo_name(trans_id))
446
unique_add(self._new_contents, trans_id, 'symlink')
449
path = FinalPaths(self).get_path(trans_id)
452
raise UnableCreateSymlink(path=path)
454
def cancel_creation(self, trans_id):
455
"""Cancel the creation of new file contents."""
456
del self._new_contents[trans_id]
457
children = self._limbo_children.get(trans_id)
458
# if this is a limbo directory with children, move them before removing
460
if children is not None:
461
self._rename_in_limbo(children)
462
del self._limbo_children[trans_id]
463
del self._limbo_children_names[trans_id]
464
delete_any(self._limbo_name(trans_id))
466
def delete_contents(self, trans_id):
467
"""Schedule the contents of a path entry for deletion"""
468
self.tree_kind(trans_id)
469
self._removed_contents.add(trans_id)
471
def cancel_deletion(self, trans_id):
472
"""Cancel a scheduled deletion"""
473
self._removed_contents.remove(trans_id)
475
def unversion_file(self, trans_id):
476
"""Schedule a path entry to become unversioned"""
477
self._removed_id.add(trans_id)
479
def delete_versioned(self, trans_id):
480
"""Delete and unversion a versioned file"""
481
self.delete_contents(trans_id)
482
self.unversion_file(trans_id)
484
def set_executability(self, executability, trans_id):
485
"""Schedule setting of the 'execute' bit
486
To unschedule, set to None
488
if executability is None:
489
del self._new_executability[trans_id]
491
unique_add(self._new_executability, trans_id, executability)
493
def set_tree_reference(self, revision_id, trans_id):
494
"""Set the reference associated with a directory"""
495
unique_add(self._new_reference_revision, trans_id, revision_id)
497
def version_file(self, file_id, trans_id):
498
"""Schedule a file to become versioned."""
499
assert file_id is not None
500
unique_add(self._new_id, trans_id, file_id)
501
unique_add(self._r_new_id, file_id, trans_id)
503
def cancel_versioning(self, trans_id):
504
"""Undo a previous versioning of a file"""
505
file_id = self._new_id[trans_id]
506
del self._new_id[trans_id]
507
del self._r_new_id[file_id]
510
"""Determine the paths of all new and changed files"""
512
fp = FinalPaths(self)
513
for id_set in (self._new_name, self._new_parent, self._new_contents,
514
self._new_id, self._new_executability):
515
new_ids.update(id_set)
516
new_paths = [(fp.get_path(t), t) for t in new_ids]
520
def tree_kind(self, trans_id):
521
"""Determine the file kind in the working tree.
523
Raises NoSuchFile if the file does not exist
525
path = self._tree_id_paths.get(trans_id)
527
raise NoSuchFile(None)
529
return file_kind(self._tree.abspath(path))
531
if e.errno != errno.ENOENT:
534
raise NoSuchFile(path)
536
def final_kind(self, trans_id):
537
"""Determine the final file kind, after any changes applied.
539
Raises NoSuchFile if the file does not exist/has no contents.
540
(It is conceivable that a path would be created without the
541
corresponding contents insertion command)
543
if trans_id in self._new_contents:
544
return self._new_contents[trans_id]
545
elif trans_id in self._removed_contents:
546
raise NoSuchFile(None)
548
return self.tree_kind(trans_id)
550
def tree_file_id(self, trans_id):
551
"""Determine the file id associated with the trans_id in the tree"""
553
path = self._tree_id_paths[trans_id]
555
# the file is a new, unversioned file, or invalid trans_id
557
# the file is old; the old id is still valid
558
if self._new_root == trans_id:
559
return self._tree.get_root_id()
560
return self._tree.inventory.path2id(path)
562
def final_file_id(self, trans_id):
563
"""Determine the file id after any changes are applied, or None.
565
None indicates that the file will not be versioned after changes are
569
# there is a new id for this file
570
assert self._new_id[trans_id] is not None
571
return self._new_id[trans_id]
573
if trans_id in self._removed_id:
575
return self.tree_file_id(trans_id)
577
def inactive_file_id(self, trans_id):
578
"""Return the inactive file_id associated with a transaction id.
579
That is, the one in the tree or in non_present_ids.
580
The file_id may actually be active, too.
582
file_id = self.tree_file_id(trans_id)
583
if file_id is not None:
585
for key, value in self._non_present_ids.iteritems():
586
if value == trans_id:
589
def final_parent(self, trans_id):
590
"""Determine the parent file_id, after any changes are applied.
592
ROOT_PARENT is returned for the tree root.
595
return self._new_parent[trans_id]
597
return self.get_tree_parent(trans_id)
599
def final_name(self, trans_id):
600
"""Determine the final filename, after all changes are applied."""
602
return self._new_name[trans_id]
605
return os.path.basename(self._tree_id_paths[trans_id])
607
raise NoFinalPath(trans_id, self)
610
"""Return a map of parent: children for known parents.
612
Only new paths and parents of tree files with assigned ids are used.
615
items = list(self._new_parent.iteritems())
616
items.extend((t, self.final_parent(t)) for t in
617
self._tree_id_paths.keys())
618
for trans_id, parent_id in items:
619
if parent_id not in by_parent:
620
by_parent[parent_id] = set()
621
by_parent[parent_id].add(trans_id)
624
def path_changed(self, trans_id):
625
"""Return True if a trans_id's path has changed."""
626
return (trans_id in self._new_name) or (trans_id in self._new_parent)
628
def new_contents(self, trans_id):
629
return (trans_id in self._new_contents)
631
def find_conflicts(self):
632
"""Find any violations of inventory or filesystem invariants"""
633
if self.__done is True:
634
raise ReusingTransform()
636
# ensure all children of all existent parents are known
637
# all children of non-existent parents are known, by definition.
638
self._add_tree_children()
639
by_parent = self.by_parent()
640
conflicts.extend(self._unversioned_parents(by_parent))
641
conflicts.extend(self._parent_loops())
642
conflicts.extend(self._duplicate_entries(by_parent))
643
conflicts.extend(self._duplicate_ids())
644
conflicts.extend(self._parent_type_conflicts(by_parent))
645
conflicts.extend(self._improper_versioning())
646
conflicts.extend(self._executability_conflicts())
647
conflicts.extend(self._overwrite_conflicts())
650
def _add_tree_children(self):
651
"""Add all the children of all active parents to the known paths.
653
Active parents are those which gain children, and those which are
654
removed. This is a necessary first step in detecting conflicts.
656
parents = self.by_parent().keys()
657
parents.extend([t for t in self._removed_contents if
658
self.tree_kind(t) == 'directory'])
659
for trans_id in self._removed_id:
660
file_id = self.tree_file_id(trans_id)
661
if self._tree.inventory[file_id].kind == 'directory':
662
parents.append(trans_id)
664
for parent_id in parents:
665
# ensure that all children are registered with the transaction
666
list(self.iter_tree_children(parent_id))
668
def iter_tree_children(self, parent_id):
669
"""Iterate through the entry's tree children, if any"""
671
path = self._tree_id_paths[parent_id]
675
children = os.listdir(self._tree.abspath(path))
677
if e.errno != errno.ENOENT and e.errno != errno.ESRCH:
681
for child in children:
682
childpath = joinpath(path, child)
683
if self._tree.is_control_filename(childpath):
685
yield self.trans_id_tree_path(childpath)
687
def has_named_child(self, by_parent, parent_id, name):
689
children = by_parent[parent_id]
692
for child in children:
693
if self.final_name(child) == name:
696
path = self._tree_id_paths[parent_id]
699
childpath = joinpath(path, name)
700
child_id = self._tree_path_ids.get(childpath)
702
return lexists(self._tree.abspath(childpath))
704
if self.final_parent(child_id) != parent_id:
706
if child_id in self._removed_contents:
707
# XXX What about dangling file-ids?
712
def _parent_loops(self):
713
"""No entry should be its own ancestor"""
715
for trans_id in self._new_parent:
718
while parent_id is not ROOT_PARENT:
721
parent_id = self.final_parent(parent_id)
724
if parent_id == trans_id:
725
conflicts.append(('parent loop', trans_id))
726
if parent_id in seen:
730
def _unversioned_parents(self, by_parent):
731
"""If parent directories are versioned, children must be versioned."""
733
for parent_id, children in by_parent.iteritems():
734
if parent_id is ROOT_PARENT:
736
if self.final_file_id(parent_id) is not None:
738
for child_id in children:
739
if self.final_file_id(child_id) is not None:
740
conflicts.append(('unversioned parent', parent_id))
744
def _improper_versioning(self):
745
"""Cannot version a file with no contents, or a bad type.
747
However, existing entries with no contents are okay.
750
for trans_id in self._new_id.iterkeys():
752
kind = self.final_kind(trans_id)
754
conflicts.append(('versioning no contents', trans_id))
756
if not InventoryEntry.versionable_kind(kind):
757
conflicts.append(('versioning bad kind', trans_id, kind))
760
def _executability_conflicts(self):
761
"""Check for bad executability changes.
763
Only versioned files may have their executability set, because
764
1. only versioned entries can have executability under windows
765
2. only files can be executable. (The execute bit on a directory
766
does not indicate searchability)
769
for trans_id in self._new_executability:
770
if self.final_file_id(trans_id) is None:
771
conflicts.append(('unversioned executability', trans_id))
774
non_file = self.final_kind(trans_id) != "file"
778
conflicts.append(('non-file executability', trans_id))
781
def _overwrite_conflicts(self):
782
"""Check for overwrites (not permitted on Win32)"""
784
for trans_id in self._new_contents:
786
self.tree_kind(trans_id)
789
if trans_id not in self._removed_contents:
790
conflicts.append(('overwrite', trans_id,
791
self.final_name(trans_id)))
794
def _duplicate_entries(self, by_parent):
795
"""No directory may have two entries with the same name."""
797
if (self._new_name, self._new_parent) == ({}, {}):
799
for children in by_parent.itervalues():
800
name_ids = [(self.final_name(t), t) for t in children]
804
for name, trans_id in name_ids:
806
kind = self.final_kind(trans_id)
809
file_id = self.final_file_id(trans_id)
810
if kind is None and file_id is None:
812
if name == last_name:
813
conflicts.append(('duplicate', last_trans_id, trans_id,
816
last_trans_id = trans_id
819
def _duplicate_ids(self):
820
"""Each inventory id may only be used once"""
822
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
824
active_tree_ids = set((f for f in self._tree.inventory if
825
f not in removed_tree_ids))
826
for trans_id, file_id in self._new_id.iteritems():
827
if file_id in active_tree_ids:
828
old_trans_id = self.trans_id_tree_file_id(file_id)
829
conflicts.append(('duplicate id', old_trans_id, trans_id))
832
def _parent_type_conflicts(self, by_parent):
833
"""parents must have directory 'contents'."""
835
for parent_id, children in by_parent.iteritems():
836
if parent_id is ROOT_PARENT:
838
if not self._any_contents(children):
840
for child in children:
842
self.final_kind(child)
846
kind = self.final_kind(parent_id)
850
conflicts.append(('missing parent', parent_id))
851
elif kind != "directory":
852
conflicts.append(('non-directory parent', parent_id))
855
def _any_contents(self, trans_ids):
856
"""Return true if any of the trans_ids, will have contents."""
857
for trans_id in trans_ids:
859
kind = self.final_kind(trans_id)
865
def apply(self, no_conflicts=False, _mover=None):
866
"""Apply all changes to the inventory and filesystem.
868
If filesystem or inventory conflicts are present, MalformedTransform
871
If apply succeeds, finalize is not necessary.
873
:param no_conflicts: if True, the caller guarantees there are no
874
conflicts, so no check is made.
875
:param _mover: Supply an alternate FileMover, for testing
878
conflicts = self.find_conflicts()
879
if len(conflicts) != 0:
880
raise MalformedTransform(conflicts=conflicts)
881
inv = self._tree.inventory
883
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
890
child_pb.update('Apply phase', 0, 2)
891
self._apply_removals(inv, inventory_delta, mover)
892
child_pb.update('Apply phase', 1, 2)
893
modified_paths = self._apply_insertions(inv, inventory_delta,
899
mover.apply_deletions()
902
self._tree.apply_inventory_delta(inventory_delta)
905
return _TransformResults(modified_paths, self.rename_count)
907
def _limbo_name(self, trans_id):
908
"""Generate the limbo name of a file"""
909
limbo_name = self._limbo_files.get(trans_id)
910
if limbo_name is not None:
912
parent = self._new_parent.get(trans_id)
913
# if the parent directory is already in limbo (e.g. when building a
914
# tree), choose a limbo name inside the parent, to reduce further
916
use_direct_path = False
917
if self._new_contents.get(parent) == 'directory':
918
filename = self._new_name.get(trans_id)
919
if filename is not None:
920
if parent not in self._limbo_children:
921
self._limbo_children[parent] = set()
922
self._limbo_children_names[parent] = {}
923
use_direct_path = True
924
# the direct path can only be used if no other file has
925
# already taken this pathname, i.e. if the name is unused, or
926
# if it is already associated with this trans_id.
927
elif (self._limbo_children_names[parent].get(filename)
928
in (trans_id, None)):
929
use_direct_path = True
931
limbo_name = pathjoin(self._limbo_files[parent], filename)
932
self._limbo_children[parent].add(trans_id)
933
self._limbo_children_names[parent][filename] = trans_id
935
limbo_name = pathjoin(self._limbodir, trans_id)
936
self._needs_rename.add(trans_id)
937
self._limbo_files[trans_id] = limbo_name
940
def _apply_removals(self, inv, inventory_delta, mover):
941
"""Perform tree operations that remove directory/inventory names.
943
That is, delete files that are to be deleted, and put any files that
944
need renaming into limbo. This must be done in strict child-to-parent
947
tree_paths = list(self._tree_path_ids.iteritems())
948
tree_paths.sort(reverse=True)
949
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
951
for num, data in enumerate(tree_paths):
952
path, trans_id = data
953
child_pb.update('removing file', num, len(tree_paths))
954
full_path = self._tree.abspath(path)
955
if trans_id in self._removed_contents:
956
mover.pre_delete(full_path, os.path.join(self._deletiondir,
958
elif trans_id in self._new_name or trans_id in \
961
mover.rename(full_path, self._limbo_name(trans_id))
963
if e.errno != errno.ENOENT:
966
self.rename_count += 1
967
if trans_id in self._removed_id:
968
if trans_id == self._new_root:
969
file_id = self._tree.get_root_id()
971
file_id = self.tree_file_id(trans_id)
972
assert file_id is not None
973
inventory_delta.append((path, None, file_id, None))
977
def _apply_insertions(self, inv, inventory_delta, mover):
978
"""Perform tree operations that insert directory/inventory names.
980
That is, create any files that need to be created, and restore from
981
limbo any files that needed renaming. This must be done in strict
982
parent-to-child order.
984
new_paths = self.new_paths()
986
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
988
for num, (path, trans_id) in enumerate(new_paths):
990
child_pb.update('adding file', num, len(new_paths))
992
kind = self._new_contents[trans_id]
994
kind = contents = None
995
if trans_id in self._new_contents or \
996
self.path_changed(trans_id):
997
full_path = self._tree.abspath(path)
998
if trans_id in self._needs_rename:
1000
mover.rename(self._limbo_name(trans_id), full_path)
1002
# We may be renaming a dangling inventory id
1003
if e.errno != errno.ENOENT:
1006
self.rename_count += 1
1007
if trans_id in self._new_contents:
1008
modified_paths.append(full_path)
1009
del self._new_contents[trans_id]
1011
if trans_id in self._new_id:
1013
kind = file_kind(self._tree.abspath(path))
1014
if trans_id in self._new_reference_revision:
1015
new_entry = inventory.TreeReference(
1016
self._new_id[trans_id],
1017
self._new_name[trans_id],
1018
self.final_file_id(self._new_parent[trans_id]),
1019
None, self._new_reference_revision[trans_id])
1021
new_entry = inventory.make_entry(kind,
1022
self.final_name(trans_id),
1023
self.final_file_id(self.final_parent(trans_id)),
1024
self._new_id[trans_id])
1026
if trans_id in self._new_name or trans_id in\
1027
self._new_parent or\
1028
trans_id in self._new_executability:
1029
file_id = self.final_file_id(trans_id)
1030
if file_id is not None:
1031
entry = inv[file_id]
1032
new_entry = entry.copy()
1034
if trans_id in self._new_name or trans_id in\
1036
if new_entry is not None:
1037
new_entry.name = self.final_name(trans_id)
1038
parent = self.final_parent(trans_id)
1039
parent_id = self.final_file_id(parent)
1040
new_entry.parent_id = parent_id
1042
if trans_id in self._new_executability:
1043
self._set_executability(path, new_entry, trans_id)
1044
if new_entry is not None:
1045
if new_entry.file_id in inv:
1046
old_path = inv.id2path(new_entry.file_id)
1049
inventory_delta.append((old_path, path,
1054
return modified_paths
1056
def _set_executability(self, path, entry, trans_id):
1057
"""Set the executability of versioned files """
1058
new_executability = self._new_executability[trans_id]
1059
entry.executable = new_executability
1060
if supports_executable():
1061
abspath = self._tree.abspath(path)
1062
current_mode = os.stat(abspath).st_mode
1063
if new_executability:
1066
to_mode = current_mode | (0100 & ~umask)
1067
# Enable x-bit for others only if they can read it.
1068
if current_mode & 0004:
1069
to_mode |= 0001 & ~umask
1070
if current_mode & 0040:
1071
to_mode |= 0010 & ~umask
1073
to_mode = current_mode & ~0111
1074
os.chmod(abspath, to_mode)
1076
def _new_entry(self, name, parent_id, file_id):
1077
"""Helper function to create a new filesystem entry."""
1078
trans_id = self.create_path(name, parent_id)
1079
if file_id is not None:
1080
self.version_file(file_id, trans_id)
1083
def new_file(self, name, parent_id, contents, file_id=None,
1085
"""Convenience method to create files.
1087
name is the name of the file to create.
1088
parent_id is the transaction id of the parent directory of the file.
1089
contents is an iterator of bytestrings, which will be used to produce
1091
:param file_id: The inventory ID of the file, if it is to be versioned.
1092
:param executable: Only valid when a file_id has been supplied.
1094
trans_id = self._new_entry(name, parent_id, file_id)
1095
# TODO: rather than scheduling a set_executable call,
1096
# have create_file create the file with the right mode.
1097
self.create_file(contents, trans_id)
1098
if executable is not None:
1099
self.set_executability(executable, trans_id)
1102
def new_directory(self, name, parent_id, file_id=None):
1103
"""Convenience method to create directories.
1105
name is the name of the directory to create.
1106
parent_id is the transaction id of the parent directory of the
1108
file_id is the inventory ID of the directory, if it is to be versioned.
1110
trans_id = self._new_entry(name, parent_id, file_id)
1111
self.create_directory(trans_id)
1114
def new_symlink(self, name, parent_id, target, file_id=None):
1115
"""Convenience method to create symbolic link.
1117
name is the name of the symlink to create.
1118
parent_id is the transaction id of the parent directory of the symlink.
1119
target is a bytestring of the target of the symlink.
1120
file_id is the inventory ID of the file, if it is to be versioned.
1122
trans_id = self._new_entry(name, parent_id, file_id)
1123
self.create_symlink(target, trans_id)
1126
def _affected_ids(self):
1127
"""Return the set of transform ids affected by the transform"""
1128
trans_ids = set(self._removed_id)
1129
trans_ids.update(self._new_id.keys())
1130
trans_ids.update(self._removed_contents)
1131
trans_ids.update(self._new_contents.keys())
1132
trans_ids.update(self._new_executability.keys())
1133
trans_ids.update(self._new_name.keys())
1134
trans_ids.update(self._new_parent.keys())
1137
def _get_file_id_maps(self):
1138
"""Return mapping of file_ids to trans_ids in the to and from states"""
1139
trans_ids = self._affected_ids()
1142
# Build up two dicts: trans_ids associated with file ids in the
1143
# FROM state, vs the TO state.
1144
for trans_id in trans_ids:
1145
from_file_id = self.tree_file_id(trans_id)
1146
if from_file_id is not None:
1147
from_trans_ids[from_file_id] = trans_id
1148
to_file_id = self.final_file_id(trans_id)
1149
if to_file_id is not None:
1150
to_trans_ids[to_file_id] = trans_id
1151
return from_trans_ids, to_trans_ids
1153
def _from_file_data(self, from_trans_id, from_versioned, file_id):
1154
"""Get data about a file in the from (tree) state
1156
Return a (name, parent, kind, executable) tuple
1158
from_path = self._tree_id_paths.get(from_trans_id)
1160
# get data from working tree if versioned
1161
from_entry = self._tree.inventory[file_id]
1162
from_name = from_entry.name
1163
from_parent = from_entry.parent_id
1166
if from_path is None:
1167
# File does not exist in FROM state
1171
# File exists, but is not versioned. Have to use path-
1173
from_name = os.path.basename(from_path)
1174
tree_parent = self.get_tree_parent(from_trans_id)
1175
from_parent = self.tree_file_id(tree_parent)
1176
if from_path is not None:
1177
from_kind, from_executable, from_stats = \
1178
self._tree._comparison_data(from_entry, from_path)
1181
from_executable = False
1182
return from_name, from_parent, from_kind, from_executable
1184
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
1185
"""Get data about a file in the to (target) state
1187
Return a (name, parent, kind, executable) tuple
1189
to_name = self.final_name(to_trans_id)
1191
to_kind = self.final_kind(to_trans_id)
1194
to_parent = self.final_file_id(self.final_parent(to_trans_id))
1195
if to_trans_id in self._new_executability:
1196
to_executable = self._new_executability[to_trans_id]
1197
elif to_trans_id == from_trans_id:
1198
to_executable = from_executable
1200
to_executable = False
1201
return to_name, to_parent, to_kind, to_executable
1203
def _iter_changes(self):
1204
"""Produce output in the same format as Tree._iter_changes.
1206
Will produce nonsensical results if invoked while inventory/filesystem
1207
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1209
This reads the Transform, but only reproduces changes involving a
1210
file_id. Files that are not versioned in either of the FROM or TO
1211
states are not reflected.
1213
final_paths = FinalPaths(self)
1214
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1216
# Now iterate through all active file_ids
1217
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1219
from_trans_id = from_trans_ids.get(file_id)
1220
# find file ids, and determine versioning state
1221
if from_trans_id is None:
1222
from_versioned = False
1223
from_trans_id = to_trans_ids[file_id]
1225
from_versioned = True
1226
to_trans_id = to_trans_ids.get(file_id)
1227
if to_trans_id is None:
1228
to_versioned = False
1229
to_trans_id = from_trans_id
1233
from_name, from_parent, from_kind, from_executable = \
1234
self._from_file_data(from_trans_id, from_versioned, file_id)
1236
to_name, to_parent, to_kind, to_executable = \
1237
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1239
if not from_versioned:
1242
from_path = self._tree_id_paths.get(from_trans_id)
1243
if not to_versioned:
1246
to_path = final_paths.get_path(to_trans_id)
1247
if from_kind != to_kind:
1249
elif to_kind in ('file', 'symlink') and (
1250
to_trans_id != from_trans_id or
1251
to_trans_id in self._new_contents):
1253
if (not modified and from_versioned == to_versioned and
1254
from_parent==to_parent and from_name == to_name and
1255
from_executable == to_executable):
1257
results.append((file_id, (from_path, to_path), modified,
1258
(from_versioned, to_versioned),
1259
(from_parent, to_parent),
1260
(from_name, to_name),
1261
(from_kind, to_kind),
1262
(from_executable, to_executable)))
1263
return iter(sorted(results, key=lambda x:x[1]))
1266
def joinpath(parent, child):
1267
"""Join tree-relative paths, handling the tree root specially"""
1268
if parent is None or parent == "":
1271
return pathjoin(parent, child)
1274
class FinalPaths(object):
1275
"""Make path calculation cheap by memoizing paths.
1277
The underlying tree must not be manipulated between calls, or else
1278
the results will likely be incorrect.
1280
def __init__(self, transform):
1281
object.__init__(self)
1282
self._known_paths = {}
1283
self.transform = transform
1285
def _determine_path(self, trans_id):
1286
if trans_id == self.transform.root:
1288
name = self.transform.final_name(trans_id)
1289
parent_id = self.transform.final_parent(trans_id)
1290
if parent_id == self.transform.root:
1293
return pathjoin(self.get_path(parent_id), name)
1295
def get_path(self, trans_id):
1296
"""Find the final path associated with a trans_id"""
1297
if trans_id not in self._known_paths:
1298
self._known_paths[trans_id] = self._determine_path(trans_id)
1299
return self._known_paths[trans_id]
1302
def topology_sorted_ids(tree):
1303
"""Determine the topological order of the ids in a tree"""
1304
file_ids = list(tree)
1305
file_ids.sort(key=tree.id2path)
1309
def build_tree(tree, wt):
1310
"""Create working tree for a branch, using a TreeTransform.
1312
This function should be used on empty trees, having a tree root at most.
1313
(see merge and revert functionality for working with existing trees)
1315
Existing files are handled like so:
1317
- Existing bzrdirs take precedence over creating new items. They are
1318
created as '%s.diverted' % name.
1319
- Otherwise, if the content on disk matches the content we are building,
1320
it is silently replaced.
1321
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1323
wt.lock_tree_write()
1327
return _build_tree(tree, wt)
1334
def _build_tree(tree, wt):
1335
"""See build_tree."""
1336
if len(wt.inventory) > 1: # more than just a root
1337
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1339
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1340
pp = ProgressPhase("Build phase", 2, top_pb)
1341
if tree.inventory.root is not None:
1342
# This is kind of a hack: we should be altering the root
1343
# as part of the regular tree shape diff logic.
1344
# The conditional test here is to avoid doing an
1345
# expensive operation (flush) every time the root id
1346
# is set within the tree, nor setting the root and thus
1347
# marking the tree as dirty, because we use two different
1348
# idioms here: tree interfaces and inventory interfaces.
1349
if wt.get_root_id() != tree.get_root_id():
1350
wt.set_root_id(tree.get_root_id())
1352
tt = TreeTransform(wt)
1356
file_trans_id[wt.get_root_id()] = \
1357
tt.trans_id_tree_file_id(wt.get_root_id())
1358
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1360
deferred_contents = []
1361
for num, (tree_path, entry) in \
1362
enumerate(tree.inventory.iter_entries_by_dir()):
1363
pb.update("Building tree", num - len(deferred_contents),
1364
len(tree.inventory))
1365
if entry.parent_id is None:
1368
file_id = entry.file_id
1369
target_path = wt.abspath(tree_path)
1371
kind = file_kind(target_path)
1375
if kind == "directory":
1377
bzrdir.BzrDir.open(target_path)
1378
except errors.NotBranchError:
1382
if (file_id not in divert and
1383
_content_match(tree, entry, file_id, kind,
1385
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1386
if kind == 'directory':
1388
if entry.parent_id not in file_trans_id:
1389
raise AssertionError(
1390
'entry %s parent id %r is not in file_trans_id %r'
1391
% (entry, entry.parent_id, file_trans_id))
1392
parent_id = file_trans_id[entry.parent_id]
1393
if entry.kind == 'file':
1394
# We *almost* replicate new_by_entry, so that we can defer
1395
# getting the file text, and get them all at once.
1396
trans_id = tt.create_path(entry.name, parent_id)
1397
file_trans_id[file_id] = trans_id
1398
tt.version_file(entry.file_id, trans_id)
1399
executable = tree.is_executable(entry.file_id, tree_path)
1400
if executable is not None:
1401
tt.set_executability(executable, trans_id)
1402
deferred_contents.append((entry.file_id, trans_id))
1404
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1407
new_trans_id = file_trans_id[file_id]
1408
old_parent = tt.trans_id_tree_path(tree_path)
1409
_reparent_children(tt, old_parent, new_trans_id)
1410
for num, (trans_id, bytes) in enumerate(
1411
tree.iter_files_bytes(deferred_contents)):
1412
tt.create_file(bytes, trans_id)
1413
pb.update('Adding file contents',
1414
(num + len(tree.inventory) - len(deferred_contents)),
1415
len(tree.inventory))
1419
divert_trans = set(file_trans_id[f] for f in divert)
1420
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1421
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1422
conflicts = cook_conflicts(raw_conflicts, tt)
1423
for conflict in conflicts:
1426
wt.add_conflicts(conflicts)
1427
except errors.UnsupportedOperation:
1436
def _reparent_children(tt, old_parent, new_parent):
1437
for child in tt.iter_tree_children(old_parent):
1438
tt.adjust_path(tt.final_name(child), new_parent, child)
1441
def _content_match(tree, entry, file_id, kind, target_path):
1442
if entry.kind != kind:
1444
if entry.kind == "directory":
1446
if entry.kind == "file":
1447
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1449
elif entry.kind == "symlink":
1450
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1455
def resolve_checkout(tt, conflicts, divert):
1456
new_conflicts = set()
1457
for c_type, conflict in ((c[0], c) for c in conflicts):
1458
# Anything but a 'duplicate' would indicate programmer error
1459
assert c_type == 'duplicate', c_type
1460
# Now figure out which is new and which is old
1461
if tt.new_contents(conflict[1]):
1462
new_file = conflict[1]
1463
old_file = conflict[2]
1465
new_file = conflict[2]
1466
old_file = conflict[1]
1468
# We should only get here if the conflict wasn't completely
1470
final_parent = tt.final_parent(old_file)
1471
if new_file in divert:
1472
new_name = tt.final_name(old_file)+'.diverted'
1473
tt.adjust_path(new_name, final_parent, new_file)
1474
new_conflicts.add((c_type, 'Diverted to',
1475
new_file, old_file))
1477
new_name = tt.final_name(old_file)+'.moved'
1478
tt.adjust_path(new_name, final_parent, old_file)
1479
new_conflicts.add((c_type, 'Moved existing file to',
1480
old_file, new_file))
1481
return new_conflicts
1484
def new_by_entry(tt, entry, parent_id, tree):
1485
"""Create a new file according to its inventory entry"""
1489
contents = tree.get_file(entry.file_id).readlines()
1490
executable = tree.is_executable(entry.file_id)
1491
return tt.new_file(name, parent_id, contents, entry.file_id,
1493
elif kind in ('directory', 'tree-reference'):
1494
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1495
if kind == 'tree-reference':
1496
tt.set_tree_reference(entry.reference_revision, trans_id)
1498
elif kind == 'symlink':
1499
target = tree.get_symlink_target(entry.file_id)
1500
return tt.new_symlink(name, parent_id, target, entry.file_id)
1502
raise errors.BadFileKindError(name, kind)
1505
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1506
"""Create new file contents according to an inventory entry."""
1507
if entry.kind == "file":
1509
lines = tree.get_file(entry.file_id).readlines()
1510
tt.create_file(lines, trans_id, mode_id=mode_id)
1511
elif entry.kind == "symlink":
1512
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
1513
elif entry.kind == "directory":
1514
tt.create_directory(trans_id)
1517
def create_entry_executability(tt, entry, trans_id):
1518
"""Set the executability of a trans_id according to an inventory entry"""
1519
if entry.kind == "file":
1520
tt.set_executability(entry.executable, trans_id)
1523
@deprecated_function(zero_fifteen)
1524
def find_interesting(working_tree, target_tree, filenames):
1525
"""Find the ids corresponding to specified filenames.
1527
Deprecated: Please use tree1.paths2ids(filenames, [tree2]).
1529
working_tree.lock_read()
1531
target_tree.lock_read()
1533
return working_tree.paths2ids(filenames, [target_tree])
1535
target_tree.unlock()
1537
working_tree.unlock()
1540
@deprecated_function(zero_ninety)
1541
def change_entry(tt, file_id, working_tree, target_tree,
1542
trans_id_file_id, backups, trans_id, by_parent):
1543
"""Replace a file_id's contents with those from a target tree."""
1544
if file_id is None and target_tree is None:
1545
# skip the logic altogether in the deprecation test
1547
e_trans_id = trans_id_file_id(file_id)
1548
entry = target_tree.inventory[file_id]
1549
has_contents, contents_mod, meta_mod, = _entry_changes(file_id, entry,
1552
mode_id = e_trans_id
1555
tt.delete_contents(e_trans_id)
1557
parent_trans_id = trans_id_file_id(entry.parent_id)
1558
backup_name = get_backup_name(entry, by_parent,
1559
parent_trans_id, tt)
1560
tt.adjust_path(backup_name, parent_trans_id, e_trans_id)
1561
tt.unversion_file(e_trans_id)
1562
e_trans_id = tt.create_path(entry.name, parent_trans_id)
1563
tt.version_file(file_id, e_trans_id)
1564
trans_id[file_id] = e_trans_id
1565
create_by_entry(tt, entry, target_tree, e_trans_id, mode_id=mode_id)
1566
create_entry_executability(tt, entry, e_trans_id)
1569
tt.set_executability(entry.executable, e_trans_id)
1570
if tt.final_name(e_trans_id) != entry.name:
1573
parent_id = tt.final_parent(e_trans_id)
1574
parent_file_id = tt.final_file_id(parent_id)
1575
if parent_file_id != entry.parent_id:
1580
parent_trans_id = trans_id_file_id(entry.parent_id)
1581
tt.adjust_path(entry.name, parent_trans_id, e_trans_id)
1584
def get_backup_name(entry, by_parent, parent_trans_id, tt):
1585
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
1588
def _get_backup_name(name, by_parent, parent_trans_id, tt):
1589
"""Produce a backup-style name that appears to be available"""
1593
yield "%s.~%d~" % (name, counter)
1595
for new_name in name_gen():
1596
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
1600
def _entry_changes(file_id, entry, working_tree):
1601
"""Determine in which ways the inventory entry has changed.
1603
Returns booleans: has_contents, content_mod, meta_mod
1604
has_contents means there are currently contents, but they differ
1605
contents_mod means contents need to be modified
1606
meta_mod means the metadata needs to be modified
1608
cur_entry = working_tree.inventory[file_id]
1610
working_kind = working_tree.kind(file_id)
1613
has_contents = False
1616
if has_contents is True:
1617
if entry.kind != working_kind:
1618
contents_mod, meta_mod = True, False
1620
cur_entry._read_tree_state(working_tree.id2path(file_id),
1622
contents_mod, meta_mod = entry.detect_changes(cur_entry)
1623
cur_entry._forget_tree_state()
1624
return has_contents, contents_mod, meta_mod
1627
def revert(working_tree, target_tree, filenames, backups=False,
1628
pb=DummyProgress(), change_reporter=None):
1629
"""Revert a working tree's contents to those of a target tree."""
1630
target_tree.lock_read()
1631
tt = TreeTransform(working_tree, pb)
1633
pp = ProgressPhase("Revert phase", 3, pb)
1635
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1637
merge_modified = _alter_files(working_tree, target_tree, tt,
1638
child_pb, filenames, backups)
1642
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1644
raw_conflicts = resolve_conflicts(tt, child_pb,
1645
lambda t, c: conflict_pass(t, c, target_tree))
1648
conflicts = cook_conflicts(raw_conflicts, tt)
1650
change_reporter = delta._ChangeReporter(
1651
unversioned_filter=working_tree.is_ignored)
1652
delta.report_changes(tt._iter_changes(), change_reporter)
1653
for conflict in conflicts:
1657
working_tree.set_merge_modified(merge_modified)
1659
target_tree.unlock()
1665
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
1667
merge_modified = working_tree.merge_modified()
1668
change_list = target_tree._iter_changes(working_tree,
1669
specific_files=specific_files, pb=pb)
1670
if target_tree.inventory.root is None:
1677
for id_num, (file_id, path, changed_content, versioned, parent, name,
1678
kind, executable) in enumerate(change_list):
1679
if skip_root and file_id[0] is not None and parent[0] is None:
1681
trans_id = tt.trans_id_file_id(file_id)
1684
keep_content = False
1685
if kind[0] == 'file' and (backups or kind[1] is None):
1686
wt_sha1 = working_tree.get_file_sha1(file_id)
1687
if merge_modified.get(file_id) != wt_sha1:
1688
# acquire the basis tree lazily to prevent the
1689
# expense of accessing it when it's not needed ?
1690
# (Guessing, RBC, 200702)
1691
if basis_tree is None:
1692
basis_tree = working_tree.basis_tree()
1693
basis_tree.lock_read()
1694
if file_id in basis_tree:
1695
if wt_sha1 != basis_tree.get_file_sha1(file_id):
1697
elif kind[1] is None and not versioned[1]:
1699
if kind[0] is not None:
1700
if not keep_content:
1701
tt.delete_contents(trans_id)
1702
elif kind[1] is not None:
1703
parent_trans_id = tt.trans_id_file_id(parent[0])
1704
by_parent = tt.by_parent()
1705
backup_name = _get_backup_name(name[0], by_parent,
1706
parent_trans_id, tt)
1707
tt.adjust_path(backup_name, parent_trans_id, trans_id)
1708
new_trans_id = tt.create_path(name[0], parent_trans_id)
1709
if versioned == (True, True):
1710
tt.unversion_file(trans_id)
1711
tt.version_file(file_id, new_trans_id)
1712
# New contents should have the same unix perms as old
1715
trans_id = new_trans_id
1716
if kind[1] == 'directory':
1717
tt.create_directory(trans_id)
1718
elif kind[1] == 'symlink':
1719
tt.create_symlink(target_tree.get_symlink_target(file_id),
1721
elif kind[1] == 'file':
1722
deferred_files.append((file_id, (trans_id, mode_id)))
1723
if basis_tree is None:
1724
basis_tree = working_tree.basis_tree()
1725
basis_tree.lock_read()
1726
new_sha1 = target_tree.get_file_sha1(file_id)
1727
if (file_id in basis_tree and new_sha1 ==
1728
basis_tree.get_file_sha1(file_id)):
1729
if file_id in merge_modified:
1730
del merge_modified[file_id]
1732
merge_modified[file_id] = new_sha1
1734
# preserve the execute bit when backing up
1735
if keep_content and executable[0] == executable[1]:
1736
tt.set_executability(executable[1], trans_id)
1738
assert kind[1] is None
1739
if versioned == (False, True):
1740
tt.version_file(file_id, trans_id)
1741
if versioned == (True, False):
1742
tt.unversion_file(trans_id)
1743
if (name[1] is not None and
1744
(name[0] != name[1] or parent[0] != parent[1])):
1746
name[1], tt.trans_id_file_id(parent[1]), trans_id)
1747
if executable[0] != executable[1] and kind[1] == "file":
1748
tt.set_executability(executable[1], trans_id)
1749
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
1751
tt.create_file(bytes, trans_id, mode_id)
1753
if basis_tree is not None:
1755
return merge_modified
1758
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
1759
"""Make many conflict-resolution attempts, but die if they fail"""
1760
if pass_func is None:
1761
pass_func = conflict_pass
1762
new_conflicts = set()
1765
pb.update('Resolution pass', n+1, 10)
1766
conflicts = tt.find_conflicts()
1767
if len(conflicts) == 0:
1768
return new_conflicts
1769
new_conflicts.update(pass_func(tt, conflicts))
1770
raise MalformedTransform(conflicts=conflicts)
1775
def conflict_pass(tt, conflicts, path_tree=None):
1776
"""Resolve some classes of conflicts.
1778
:param tt: The transform to resolve conflicts in
1779
:param conflicts: The conflicts to resolve
1780
:param path_tree: A Tree to get supplemental paths from
1782
new_conflicts = set()
1783
for c_type, conflict in ((c[0], c) for c in conflicts):
1784
if c_type == 'duplicate id':
1785
tt.unversion_file(conflict[1])
1786
new_conflicts.add((c_type, 'Unversioned existing file',
1787
conflict[1], conflict[2], ))
1788
elif c_type == 'duplicate':
1789
# files that were renamed take precedence
1790
new_name = tt.final_name(conflict[1])+'.moved'
1791
final_parent = tt.final_parent(conflict[1])
1792
if tt.path_changed(conflict[1]):
1793
tt.adjust_path(new_name, final_parent, conflict[2])
1794
new_conflicts.add((c_type, 'Moved existing file to',
1795
conflict[2], conflict[1]))
1797
tt.adjust_path(new_name, final_parent, conflict[1])
1798
new_conflicts.add((c_type, 'Moved existing file to',
1799
conflict[1], conflict[2]))
1800
elif c_type == 'parent loop':
1801
# break the loop by undoing one of the ops that caused the loop
1803
while not tt.path_changed(cur):
1804
cur = tt.final_parent(cur)
1805
new_conflicts.add((c_type, 'Cancelled move', cur,
1806
tt.final_parent(cur),))
1807
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
1809
elif c_type == 'missing parent':
1810
trans_id = conflict[1]
1812
tt.cancel_deletion(trans_id)
1813
new_conflicts.add(('deleting parent', 'Not deleting',
1816
tt.create_directory(trans_id)
1817
new_conflicts.add((c_type, 'Created directory', trans_id))
1819
tt.final_name(trans_id)
1821
if path_tree is not None:
1822
file_id = tt.final_file_id(trans_id)
1823
entry = path_tree.inventory[file_id]
1824
parent_trans_id = tt.trans_id_file_id(entry.parent_id)
1825
tt.adjust_path(entry.name, parent_trans_id, trans_id)
1826
elif c_type == 'unversioned parent':
1827
tt.version_file(tt.inactive_file_id(conflict[1]), conflict[1])
1828
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
1829
return new_conflicts
1832
def cook_conflicts(raw_conflicts, tt):
1833
"""Generate a list of cooked conflicts, sorted by file path"""
1834
from bzrlib.conflicts import Conflict
1835
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
1836
return sorted(conflict_iter, key=Conflict.sort_key)
1839
def iter_cook_conflicts(raw_conflicts, tt):
1840
from bzrlib.conflicts import Conflict
1842
for conflict in raw_conflicts:
1843
c_type = conflict[0]
1844
action = conflict[1]
1845
modified_path = fp.get_path(conflict[2])
1846
modified_id = tt.final_file_id(conflict[2])
1847
if len(conflict) == 3:
1848
yield Conflict.factory(c_type, action=action, path=modified_path,
1849
file_id=modified_id)
1852
conflicting_path = fp.get_path(conflict[3])
1853
conflicting_id = tt.final_file_id(conflict[3])
1854
yield Conflict.factory(c_type, action=action, path=modified_path,
1855
file_id=modified_id,
1856
conflict_path=conflicting_path,
1857
conflict_file_id=conflicting_id)
1860
class _FileMover(object):
1861
"""Moves and deletes files for TreeTransform, tracking operations"""
1864
self.past_renames = []
1865
self.pending_deletions = []
1867
def rename(self, from_, to):
1868
"""Rename a file from one path to another. Functions like os.rename"""
1869
os.rename(from_, to)
1870
self.past_renames.append((from_, to))
1872
def pre_delete(self, from_, to):
1873
"""Rename a file out of the way and mark it for deletion.
1875
Unlike os.unlink, this works equally well for files and directories.
1876
:param from_: The current file path
1877
:param to: A temporary path for the file
1879
self.rename(from_, to)
1880
self.pending_deletions.append(to)
1883
"""Reverse all renames that have been performed"""
1884
for from_, to in reversed(self.past_renames):
1885
os.rename(to, from_)
1886
# after rollback, don't reuse _FileMover
1888
pending_deletions = None
1890
def apply_deletions(self):
1891
"""Apply all marked deletions"""
1892
for path in self.pending_deletions:
1894
# after apply_deletions, don't reuse _FileMover
1896
pending_deletions = None
added
removed
bzrlib/transform.py
