1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
from stat import S_ISREG, S_IEXEC
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
30
revision as _mod_revision,
33
from bzrlib.errors import (DuplicateKey, MalformedTransform, NoSuchFile,
34
ReusingTransform, NotVersionedError, CantMoveRoot,
35
ExistingLimbo, ImmortalLimbo, NoFinalPath,
37
from bzrlib.inventory import InventoryEntry
38
from bzrlib.osutils import (
47
from bzrlib.progress import DummyProgress, ProgressPhase
48
from bzrlib.symbol_versioning import (
51
from bzrlib.trace import mutter, warning
52
from bzrlib import tree
54
import bzrlib.urlutils as urlutils
57
ROOT_PARENT = "root-parent"
60
def unique_add(map, key, value):
62
raise DuplicateKey(key=key)
66
class _TransformResults(object):
67
def __init__(self, modified_paths, rename_count):
69
self.modified_paths = modified_paths
70
self.rename_count = rename_count
73
class TreeTransformBase(object):
74
"""The base class for TreeTransform and TreeTransformBase"""
76
def __init__(self, tree, limbodir, pb=DummyProgress(),
80
:param tree: The tree that will be transformed, but not necessarily
82
:param limbodir: A directory where new files can be stored until
83
they are installed in their proper places
84
:param pb: A ProgressBar indicating how much progress is being made
85
:param case_sensitive: If True, the target of the transform is
86
case sensitive, not just case preserving.
90
self._limbodir = limbodir
91
self._deletiondir = None
93
# mapping of trans_id -> new basename
95
# mapping of trans_id -> new parent trans_id
97
# mapping of trans_id with new contents -> new file_kind
98
self._new_contents = {}
99
# A mapping of transform ids to their limbo filename
100
self._limbo_files = {}
101
# A mapping of transform ids to a set of the transform ids of children
102
# that their limbo directory has
103
self._limbo_children = {}
104
# Map transform ids to maps of child filename to child transform id
105
self._limbo_children_names = {}
106
# List of transform ids that need to be renamed from limbo into place
107
self._needs_rename = set()
108
# Set of trans_ids whose contents will be removed
109
self._removed_contents = set()
110
# Mapping of trans_id -> new execute-bit value
111
self._new_executability = {}
112
# Mapping of trans_id -> new tree-reference value
113
self._new_reference_revision = {}
114
# Mapping of trans_id -> new file_id
116
# Mapping of old file-id -> trans_id
117
self._non_present_ids = {}
118
# Mapping of new file_id -> trans_id
120
# Set of file_ids that will be removed
121
self._removed_id = set()
122
# Mapping of path in old tree -> trans_id
123
self._tree_path_ids = {}
124
# Mapping trans_id -> path in old tree
125
self._tree_id_paths = {}
126
# Cache of realpath results, to speed up canonical_path
128
# Cache of relpath results, to speed up canonical_path
130
# The trans_id that will be used as the tree root
131
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
132
# Indictor of whether the transform has been applied
136
# Whether the target is case sensitive
137
self._case_sensitive_target = case_sensitive
138
# A counter of how many files have been renamed
139
self.rename_count = 0
141
def __get_root(self):
142
return self._new_root
144
root = property(__get_root)
147
"""Release the working tree lock, if held, clean up limbo dir.
149
This is required if apply has not been invoked, but can be invoked
152
if self._tree is None:
155
entries = [(self._limbo_name(t), t, k) for t, k in
156
self._new_contents.iteritems()]
157
entries.sort(reverse=True)
158
for path, trans_id, kind in entries:
159
if kind == "directory":
164
os.rmdir(self._limbodir)
166
# We don't especially care *why* the dir is immortal.
167
raise ImmortalLimbo(self._limbodir)
169
if self._deletiondir is not None:
170
os.rmdir(self._deletiondir)
172
raise errors.ImmortalPendingDeletion(self._deletiondir)
177
def _assign_id(self):
178
"""Produce a new tranform id"""
179
new_id = "new-%s" % self._id_number
183
def create_path(self, name, parent):
184
"""Assign a transaction id to a new path"""
185
trans_id = self._assign_id()
186
unique_add(self._new_name, trans_id, name)
187
unique_add(self._new_parent, trans_id, parent)
190
def adjust_path(self, name, parent, trans_id):
191
"""Change the path that is assigned to a transaction id."""
192
if trans_id == self._new_root:
194
previous_parent = self._new_parent.get(trans_id)
195
previous_name = self._new_name.get(trans_id)
196
self._new_name[trans_id] = name
197
self._new_parent[trans_id] = parent
198
if (trans_id in self._limbo_files and
199
trans_id not in self._needs_rename):
200
self._rename_in_limbo([trans_id])
201
self._limbo_children[previous_parent].remove(trans_id)
202
del self._limbo_children_names[previous_parent][previous_name]
204
def _rename_in_limbo(self, trans_ids):
205
"""Fix limbo names so that the right final path is produced.
207
This means we outsmarted ourselves-- we tried to avoid renaming
208
these files later by creating them with their final names in their
209
final parents. But now the previous name or parent is no longer
210
suitable, so we have to rename them.
212
Even for trans_ids that have no new contents, we must remove their
213
entries from _limbo_files, because they are now stale.
215
for trans_id in trans_ids:
216
old_path = self._limbo_files.pop(trans_id)
217
if trans_id not in self._new_contents:
219
new_path = self._limbo_name(trans_id)
220
os.rename(old_path, new_path)
222
def adjust_root_path(self, name, parent):
223
"""Emulate moving the root by moving all children, instead.
225
We do this by undoing the association of root's transaction id with the
226
current tree. This allows us to create a new directory with that
227
transaction id. We unversion the root directory and version the
228
physically new directory, and hope someone versions the tree root
231
old_root = self._new_root
232
old_root_file_id = self.final_file_id(old_root)
233
# force moving all children of root
234
for child_id in self.iter_tree_children(old_root):
235
if child_id != parent:
236
self.adjust_path(self.final_name(child_id),
237
self.final_parent(child_id), child_id)
238
file_id = self.final_file_id(child_id)
239
if file_id is not None:
240
self.unversion_file(child_id)
241
self.version_file(file_id, child_id)
243
# the physical root needs a new transaction id
244
self._tree_path_ids.pop("")
245
self._tree_id_paths.pop(old_root)
246
self._new_root = self.trans_id_tree_file_id(self._tree.get_root_id())
247
if parent == old_root:
248
parent = self._new_root
249
self.adjust_path(name, parent, old_root)
250
self.create_directory(old_root)
251
self.version_file(old_root_file_id, old_root)
252
self.unversion_file(self._new_root)
254
def trans_id_tree_file_id(self, inventory_id):
255
"""Determine the transaction id of a working tree file.
257
This reflects only files that already exist, not ones that will be
258
added by transactions.
260
path = self._tree.id2path(inventory_id)
261
return self.trans_id_tree_path(path)
263
def trans_id_file_id(self, file_id):
264
"""Determine or set the transaction id associated with a file ID.
265
A new id is only created for file_ids that were never present. If
266
a transaction has been unversioned, it is deliberately still returned.
267
(this will likely lead to an unversioned parent conflict.)
269
if file_id in self._r_new_id and self._r_new_id[file_id] is not None:
270
return self._r_new_id[file_id]
271
elif file_id in self._tree.inventory:
272
return self.trans_id_tree_file_id(file_id)
273
elif file_id in self._non_present_ids:
274
return self._non_present_ids[file_id]
276
trans_id = self._assign_id()
277
self._non_present_ids[file_id] = trans_id
280
def canonical_path(self, path):
281
"""Get the canonical tree-relative path"""
282
# don't follow final symlinks
283
abs = self._tree.abspath(path)
284
if abs in self._relpaths:
285
return self._relpaths[abs]
286
dirname, basename = os.path.split(abs)
287
if dirname not in self._realpaths:
288
self._realpaths[dirname] = os.path.realpath(dirname)
289
dirname = self._realpaths[dirname]
290
abs = pathjoin(dirname, basename)
291
if dirname in self._relpaths:
292
relpath = pathjoin(self._relpaths[dirname], basename)
293
relpath = relpath.rstrip('/\\')
295
relpath = self._tree.relpath(abs)
296
self._relpaths[abs] = relpath
299
def trans_id_tree_path(self, path):
300
"""Determine (and maybe set) the transaction ID for a tree path."""
301
path = self.canonical_path(path)
302
if path not in self._tree_path_ids:
303
self._tree_path_ids[path] = self._assign_id()
304
self._tree_id_paths[self._tree_path_ids[path]] = path
305
return self._tree_path_ids[path]
307
def get_tree_parent(self, trans_id):
308
"""Determine id of the parent in the tree."""
309
path = self._tree_id_paths[trans_id]
312
return self.trans_id_tree_path(os.path.dirname(path))
314
def create_file(self, contents, trans_id, mode_id=None):
315
"""Schedule creation of a new file.
319
Contents is an iterator of strings, all of which will be written
320
to the target destination.
322
New file takes the permissions of any existing file with that id,
323
unless mode_id is specified.
325
name = self._limbo_name(trans_id)
329
unique_add(self._new_contents, trans_id, 'file')
331
# Clean up the file, it never got registered so
332
# TreeTransform.finalize() won't clean it up.
337
f.writelines(contents)
340
self._set_mode(trans_id, mode_id, S_ISREG)
342
def _set_mode(self, trans_id, mode_id, typefunc):
343
"""Set the mode of new file contents.
344
The mode_id is the existing file to get the mode from (often the same
345
as trans_id). The operation is only performed if there's a mode match
346
according to typefunc.
351
old_path = self._tree_id_paths[mode_id]
355
mode = os.stat(self._tree.abspath(old_path)).st_mode
357
if e.errno == errno.ENOENT:
362
os.chmod(self._limbo_name(trans_id), mode)
364
def create_hardlink(self, path, trans_id):
365
"""Schedule creation of a hard link"""
366
name = self._limbo_name(trans_id)
370
if e.errno != errno.EPERM:
372
raise errors.HardLinkNotSupported(path)
374
unique_add(self._new_contents, trans_id, 'file')
376
# Clean up the file, it never got registered so
377
# TreeTransform.finalize() won't clean it up.
381
def create_directory(self, trans_id):
382
"""Schedule creation of a new directory.
384
See also new_directory.
386
os.mkdir(self._limbo_name(trans_id))
387
unique_add(self._new_contents, trans_id, 'directory')
389
def create_symlink(self, target, trans_id):
390
"""Schedule creation of a new symbolic link.
392
target is a bytestring.
393
See also new_symlink.
396
os.symlink(target, self._limbo_name(trans_id))
397
unique_add(self._new_contents, trans_id, 'symlink')
400
path = FinalPaths(self).get_path(trans_id)
403
raise UnableCreateSymlink(path=path)
405
def cancel_creation(self, trans_id):
406
"""Cancel the creation of new file contents."""
407
del self._new_contents[trans_id]
408
children = self._limbo_children.get(trans_id)
409
# if this is a limbo directory with children, move them before removing
411
if children is not None:
412
self._rename_in_limbo(children)
413
del self._limbo_children[trans_id]
414
del self._limbo_children_names[trans_id]
415
delete_any(self._limbo_name(trans_id))
417
def delete_contents(self, trans_id):
418
"""Schedule the contents of a path entry for deletion"""
419
self.tree_kind(trans_id)
420
self._removed_contents.add(trans_id)
422
def cancel_deletion(self, trans_id):
423
"""Cancel a scheduled deletion"""
424
self._removed_contents.remove(trans_id)
426
def unversion_file(self, trans_id):
427
"""Schedule a path entry to become unversioned"""
428
self._removed_id.add(trans_id)
430
def delete_versioned(self, trans_id):
431
"""Delete and unversion a versioned file"""
432
self.delete_contents(trans_id)
433
self.unversion_file(trans_id)
435
def set_executability(self, executability, trans_id):
436
"""Schedule setting of the 'execute' bit
437
To unschedule, set to None
439
if executability is None:
440
del self._new_executability[trans_id]
442
unique_add(self._new_executability, trans_id, executability)
444
def set_tree_reference(self, revision_id, trans_id):
445
"""Set the reference associated with a directory"""
446
unique_add(self._new_reference_revision, trans_id, revision_id)
448
def version_file(self, file_id, trans_id):
449
"""Schedule a file to become versioned."""
452
unique_add(self._new_id, trans_id, file_id)
453
unique_add(self._r_new_id, file_id, trans_id)
455
def cancel_versioning(self, trans_id):
456
"""Undo a previous versioning of a file"""
457
file_id = self._new_id[trans_id]
458
del self._new_id[trans_id]
459
del self._r_new_id[file_id]
461
def new_paths(self, filesystem_only=False):
462
"""Determine the paths of all new and changed files.
464
:param filesystem_only: if True, only calculate values for files
465
that require renames or execute bit changes.
469
id_sets = (self._needs_rename, self._new_executability)
471
id_sets = (self._new_name, self._new_parent, self._new_contents,
472
self._new_id, self._new_executability)
473
for id_set in id_sets:
474
new_ids.update(id_set)
475
return sorted(FinalPaths(self).get_paths(new_ids))
477
def tree_kind(self, trans_id):
478
"""Determine the file kind in the working tree.
480
Raises NoSuchFile if the file does not exist
482
path = self._tree_id_paths.get(trans_id)
484
raise NoSuchFile(None)
486
return file_kind(self._tree.abspath(path))
488
if e.errno != errno.ENOENT:
491
raise NoSuchFile(path)
493
def final_kind(self, trans_id):
494
"""Determine the final file kind, after any changes applied.
496
Raises NoSuchFile if the file does not exist/has no contents.
497
(It is conceivable that a path would be created without the
498
corresponding contents insertion command)
500
if trans_id in self._new_contents:
501
return self._new_contents[trans_id]
502
elif trans_id in self._removed_contents:
503
raise NoSuchFile(None)
505
return self.tree_kind(trans_id)
507
def tree_file_id(self, trans_id):
508
"""Determine the file id associated with the trans_id in the tree"""
510
path = self._tree_id_paths[trans_id]
512
# the file is a new, unversioned file, or invalid trans_id
514
# the file is old; the old id is still valid
515
if self._new_root == trans_id:
516
return self._tree.get_root_id()
517
return self._tree.inventory.path2id(path)
519
def final_file_id(self, trans_id):
520
"""Determine the file id after any changes are applied, or None.
522
None indicates that the file will not be versioned after changes are
526
return self._new_id[trans_id]
528
if trans_id in self._removed_id:
530
return self.tree_file_id(trans_id)
532
def inactive_file_id(self, trans_id):
533
"""Return the inactive file_id associated with a transaction id.
534
That is, the one in the tree or in non_present_ids.
535
The file_id may actually be active, too.
537
file_id = self.tree_file_id(trans_id)
538
if file_id is not None:
540
for key, value in self._non_present_ids.iteritems():
541
if value == trans_id:
544
def final_parent(self, trans_id):
545
"""Determine the parent file_id, after any changes are applied.
547
ROOT_PARENT is returned for the tree root.
550
return self._new_parent[trans_id]
552
return self.get_tree_parent(trans_id)
554
def final_name(self, trans_id):
555
"""Determine the final filename, after all changes are applied."""
557
return self._new_name[trans_id]
560
return os.path.basename(self._tree_id_paths[trans_id])
562
raise NoFinalPath(trans_id, self)
565
"""Return a map of parent: children for known parents.
567
Only new paths and parents of tree files with assigned ids are used.
570
items = list(self._new_parent.iteritems())
571
items.extend((t, self.final_parent(t)) for t in
572
self._tree_id_paths.keys())
573
for trans_id, parent_id in items:
574
if parent_id not in by_parent:
575
by_parent[parent_id] = set()
576
by_parent[parent_id].add(trans_id)
579
def path_changed(self, trans_id):
580
"""Return True if a trans_id's path has changed."""
581
return (trans_id in self._new_name) or (trans_id in self._new_parent)
583
def new_contents(self, trans_id):
584
return (trans_id in self._new_contents)
586
def find_conflicts(self):
587
"""Find any violations of inventory or filesystem invariants"""
588
if self._done is True:
589
raise ReusingTransform()
591
# ensure all children of all existent parents are known
592
# all children of non-existent parents are known, by definition.
593
self._add_tree_children()
594
by_parent = self.by_parent()
595
conflicts.extend(self._unversioned_parents(by_parent))
596
conflicts.extend(self._parent_loops())
597
conflicts.extend(self._duplicate_entries(by_parent))
598
conflicts.extend(self._duplicate_ids())
599
conflicts.extend(self._parent_type_conflicts(by_parent))
600
conflicts.extend(self._improper_versioning())
601
conflicts.extend(self._executability_conflicts())
602
conflicts.extend(self._overwrite_conflicts())
605
def _add_tree_children(self):
606
"""Add all the children of all active parents to the known paths.
608
Active parents are those which gain children, and those which are
609
removed. This is a necessary first step in detecting conflicts.
611
parents = self.by_parent().keys()
612
parents.extend([t for t in self._removed_contents if
613
self.tree_kind(t) == 'directory'])
614
for trans_id in self._removed_id:
615
file_id = self.tree_file_id(trans_id)
616
if file_id is not None:
617
if self._tree.inventory[file_id].kind == 'directory':
618
parents.append(trans_id)
619
elif self.tree_kind(trans_id) == 'directory':
620
parents.append(trans_id)
622
for parent_id in parents:
623
# ensure that all children are registered with the transaction
624
list(self.iter_tree_children(parent_id))
626
def iter_tree_children(self, parent_id):
627
"""Iterate through the entry's tree children, if any"""
629
path = self._tree_id_paths[parent_id]
633
children = os.listdir(self._tree.abspath(path))
635
if e.errno not in (errno.ENOENT, errno.ESRCH, errno.ENOTDIR):
639
for child in children:
640
childpath = joinpath(path, child)
641
if self._tree.is_control_filename(childpath):
643
yield self.trans_id_tree_path(childpath)
645
def has_named_child(self, by_parent, parent_id, name):
647
children = by_parent[parent_id]
650
for child in children:
651
if self.final_name(child) == name:
654
path = self._tree_id_paths[parent_id]
657
childpath = joinpath(path, name)
658
child_id = self._tree_path_ids.get(childpath)
660
return lexists(self._tree.abspath(childpath))
662
if self.final_parent(child_id) != parent_id:
664
if child_id in self._removed_contents:
665
# XXX What about dangling file-ids?
670
def _parent_loops(self):
671
"""No entry should be its own ancestor"""
673
for trans_id in self._new_parent:
676
while parent_id is not ROOT_PARENT:
679
parent_id = self.final_parent(parent_id)
682
if parent_id == trans_id:
683
conflicts.append(('parent loop', trans_id))
684
if parent_id in seen:
688
def _unversioned_parents(self, by_parent):
689
"""If parent directories are versioned, children must be versioned."""
691
for parent_id, children in by_parent.iteritems():
692
if parent_id is ROOT_PARENT:
694
if self.final_file_id(parent_id) is not None:
696
for child_id in children:
697
if self.final_file_id(child_id) is not None:
698
conflicts.append(('unversioned parent', parent_id))
702
def _improper_versioning(self):
703
"""Cannot version a file with no contents, or a bad type.
705
However, existing entries with no contents are okay.
708
for trans_id in self._new_id.iterkeys():
710
kind = self.final_kind(trans_id)
712
conflicts.append(('versioning no contents', trans_id))
714
if not InventoryEntry.versionable_kind(kind):
715
conflicts.append(('versioning bad kind', trans_id, kind))
718
def _executability_conflicts(self):
719
"""Check for bad executability changes.
721
Only versioned files may have their executability set, because
722
1. only versioned entries can have executability under windows
723
2. only files can be executable. (The execute bit on a directory
724
does not indicate searchability)
727
for trans_id in self._new_executability:
728
if self.final_file_id(trans_id) is None:
729
conflicts.append(('unversioned executability', trans_id))
732
non_file = self.final_kind(trans_id) != "file"
736
conflicts.append(('non-file executability', trans_id))
739
def _overwrite_conflicts(self):
740
"""Check for overwrites (not permitted on Win32)"""
742
for trans_id in self._new_contents:
744
self.tree_kind(trans_id)
747
if trans_id not in self._removed_contents:
748
conflicts.append(('overwrite', trans_id,
749
self.final_name(trans_id)))
752
def _duplicate_entries(self, by_parent):
753
"""No directory may have two entries with the same name."""
755
if (self._new_name, self._new_parent) == ({}, {}):
757
for children in by_parent.itervalues():
758
name_ids = [(self.final_name(t), t) for t in children]
759
if not self._case_sensitive_target:
760
name_ids = [(n.lower(), t) for n, t in name_ids]
764
for name, trans_id in name_ids:
766
kind = self.final_kind(trans_id)
769
file_id = self.final_file_id(trans_id)
770
if kind is None and file_id is None:
772
if name == last_name:
773
conflicts.append(('duplicate', last_trans_id, trans_id,
776
last_trans_id = trans_id
779
def _duplicate_ids(self):
780
"""Each inventory id may only be used once"""
782
removed_tree_ids = set((self.tree_file_id(trans_id) for trans_id in
784
all_ids = self._tree.all_file_ids()
785
active_tree_ids = all_ids.difference(removed_tree_ids)
786
for trans_id, file_id in self._new_id.iteritems():
787
if file_id in active_tree_ids:
788
old_trans_id = self.trans_id_tree_file_id(file_id)
789
conflicts.append(('duplicate id', old_trans_id, trans_id))
792
def _parent_type_conflicts(self, by_parent):
793
"""parents must have directory 'contents'."""
795
for parent_id, children in by_parent.iteritems():
796
if parent_id is ROOT_PARENT:
798
if not self._any_contents(children):
800
for child in children:
802
self.final_kind(child)
806
kind = self.final_kind(parent_id)
810
conflicts.append(('missing parent', parent_id))
811
elif kind != "directory":
812
conflicts.append(('non-directory parent', parent_id))
815
def _any_contents(self, trans_ids):
816
"""Return true if any of the trans_ids, will have contents."""
817
for trans_id in trans_ids:
819
kind = self.final_kind(trans_id)
825
def _limbo_name(self, trans_id):
826
"""Generate the limbo name of a file"""
827
limbo_name = self._limbo_files.get(trans_id)
828
if limbo_name is not None:
830
parent = self._new_parent.get(trans_id)
831
# if the parent directory is already in limbo (e.g. when building a
832
# tree), choose a limbo name inside the parent, to reduce further
834
use_direct_path = False
835
if self._new_contents.get(parent) == 'directory':
836
filename = self._new_name.get(trans_id)
837
if filename is not None:
838
if parent not in self._limbo_children:
839
self._limbo_children[parent] = set()
840
self._limbo_children_names[parent] = {}
841
use_direct_path = True
842
# the direct path can only be used if no other file has
843
# already taken this pathname, i.e. if the name is unused, or
844
# if it is already associated with this trans_id.
845
elif self._case_sensitive_target:
846
if (self._limbo_children_names[parent].get(filename)
847
in (trans_id, None)):
848
use_direct_path = True
850
for l_filename, l_trans_id in\
851
self._limbo_children_names[parent].iteritems():
852
if l_trans_id == trans_id:
854
if l_filename.lower() == filename.lower():
857
use_direct_path = True
860
limbo_name = pathjoin(self._limbo_files[parent], filename)
861
self._limbo_children[parent].add(trans_id)
862
self._limbo_children_names[parent][filename] = trans_id
864
limbo_name = pathjoin(self._limbodir, trans_id)
865
self._needs_rename.add(trans_id)
866
self._limbo_files[trans_id] = limbo_name
869
def _set_executability(self, path, entry, trans_id):
870
"""Set the executability of versioned files """
871
new_executability = self._new_executability[trans_id]
872
if entry is not None:
873
entry.executable = new_executability
874
if supports_executable():
875
abspath = self._tree.abspath(path)
876
current_mode = os.stat(abspath).st_mode
877
if new_executability:
880
to_mode = current_mode | (0100 & ~umask)
881
# Enable x-bit for others only if they can read it.
882
if current_mode & 0004:
883
to_mode |= 0001 & ~umask
884
if current_mode & 0040:
885
to_mode |= 0010 & ~umask
887
to_mode = current_mode & ~0111
888
os.chmod(abspath, to_mode)
890
def _new_entry(self, name, parent_id, file_id):
891
"""Helper function to create a new filesystem entry."""
892
trans_id = self.create_path(name, parent_id)
893
if file_id is not None:
894
self.version_file(file_id, trans_id)
897
def new_file(self, name, parent_id, contents, file_id=None,
899
"""Convenience method to create files.
901
name is the name of the file to create.
902
parent_id is the transaction id of the parent directory of the file.
903
contents is an iterator of bytestrings, which will be used to produce
905
:param file_id: The inventory ID of the file, if it is to be versioned.
906
:param executable: Only valid when a file_id has been supplied.
908
trans_id = self._new_entry(name, parent_id, file_id)
909
# TODO: rather than scheduling a set_executable call,
910
# have create_file create the file with the right mode.
911
self.create_file(contents, trans_id)
912
if executable is not None:
913
self.set_executability(executable, trans_id)
916
def new_directory(self, name, parent_id, file_id=None):
917
"""Convenience method to create directories.
919
name is the name of the directory to create.
920
parent_id is the transaction id of the parent directory of the
922
file_id is the inventory ID of the directory, if it is to be versioned.
924
trans_id = self._new_entry(name, parent_id, file_id)
925
self.create_directory(trans_id)
928
def new_symlink(self, name, parent_id, target, file_id=None):
929
"""Convenience method to create symbolic link.
931
name is the name of the symlink to create.
932
parent_id is the transaction id of the parent directory of the symlink.
933
target is a bytestring of the target of the symlink.
934
file_id is the inventory ID of the file, if it is to be versioned.
936
trans_id = self._new_entry(name, parent_id, file_id)
937
self.create_symlink(target, trans_id)
940
def _affected_ids(self):
941
"""Return the set of transform ids affected by the transform"""
942
trans_ids = set(self._removed_id)
943
trans_ids.update(self._new_id.keys())
944
trans_ids.update(self._removed_contents)
945
trans_ids.update(self._new_contents.keys())
946
trans_ids.update(self._new_executability.keys())
947
trans_ids.update(self._new_name.keys())
948
trans_ids.update(self._new_parent.keys())
951
def _get_file_id_maps(self):
952
"""Return mapping of file_ids to trans_ids in the to and from states"""
953
trans_ids = self._affected_ids()
956
# Build up two dicts: trans_ids associated with file ids in the
957
# FROM state, vs the TO state.
958
for trans_id in trans_ids:
959
from_file_id = self.tree_file_id(trans_id)
960
if from_file_id is not None:
961
from_trans_ids[from_file_id] = trans_id
962
to_file_id = self.final_file_id(trans_id)
963
if to_file_id is not None:
964
to_trans_ids[to_file_id] = trans_id
965
return from_trans_ids, to_trans_ids
967
def _from_file_data(self, from_trans_id, from_versioned, file_id):
968
"""Get data about a file in the from (tree) state
970
Return a (name, parent, kind, executable) tuple
972
from_path = self._tree_id_paths.get(from_trans_id)
974
# get data from working tree if versioned
975
from_entry = self._tree.inventory[file_id]
976
from_name = from_entry.name
977
from_parent = from_entry.parent_id
980
if from_path is None:
981
# File does not exist in FROM state
985
# File exists, but is not versioned. Have to use path-
987
from_name = os.path.basename(from_path)
988
tree_parent = self.get_tree_parent(from_trans_id)
989
from_parent = self.tree_file_id(tree_parent)
990
if from_path is not None:
991
from_kind, from_executable, from_stats = \
992
self._tree._comparison_data(from_entry, from_path)
995
from_executable = False
996
return from_name, from_parent, from_kind, from_executable
998
def _to_file_data(self, to_trans_id, from_trans_id, from_executable):
999
"""Get data about a file in the to (target) state
1001
Return a (name, parent, kind, executable) tuple
1003
to_name = self.final_name(to_trans_id)
1005
to_kind = self.final_kind(to_trans_id)
1008
to_parent = self.final_file_id(self.final_parent(to_trans_id))
1009
if to_trans_id in self._new_executability:
1010
to_executable = self._new_executability[to_trans_id]
1011
elif to_trans_id == from_trans_id:
1012
to_executable = from_executable
1014
to_executable = False
1015
return to_name, to_parent, to_kind, to_executable
1017
def iter_changes(self):
1018
"""Produce output in the same format as Tree.iter_changes.
1020
Will produce nonsensical results if invoked while inventory/filesystem
1021
conflicts (as reported by TreeTransform.find_conflicts()) are present.
1023
This reads the Transform, but only reproduces changes involving a
1024
file_id. Files that are not versioned in either of the FROM or TO
1025
states are not reflected.
1027
final_paths = FinalPaths(self)
1028
from_trans_ids, to_trans_ids = self._get_file_id_maps()
1030
# Now iterate through all active file_ids
1031
for file_id in set(from_trans_ids.keys() + to_trans_ids.keys()):
1033
from_trans_id = from_trans_ids.get(file_id)
1034
# find file ids, and determine versioning state
1035
if from_trans_id is None:
1036
from_versioned = False
1037
from_trans_id = to_trans_ids[file_id]
1039
from_versioned = True
1040
to_trans_id = to_trans_ids.get(file_id)
1041
if to_trans_id is None:
1042
to_versioned = False
1043
to_trans_id = from_trans_id
1047
from_name, from_parent, from_kind, from_executable = \
1048
self._from_file_data(from_trans_id, from_versioned, file_id)
1050
to_name, to_parent, to_kind, to_executable = \
1051
self._to_file_data(to_trans_id, from_trans_id, from_executable)
1053
if not from_versioned:
1056
from_path = self._tree_id_paths.get(from_trans_id)
1057
if not to_versioned:
1060
to_path = final_paths.get_path(to_trans_id)
1061
if from_kind != to_kind:
1063
elif to_kind in ('file', 'symlink') and (
1064
to_trans_id != from_trans_id or
1065
to_trans_id in self._new_contents):
1067
if (not modified and from_versioned == to_versioned and
1068
from_parent==to_parent and from_name == to_name and
1069
from_executable == to_executable):
1071
results.append((file_id, (from_path, to_path), modified,
1072
(from_versioned, to_versioned),
1073
(from_parent, to_parent),
1074
(from_name, to_name),
1075
(from_kind, to_kind),
1076
(from_executable, to_executable)))
1077
return iter(sorted(results, key=lambda x:x[1]))
1079
def get_preview_tree(self):
1080
"""Return a tree representing the result of the transform.
1082
This tree only supports the subset of Tree functionality required
1083
by show_diff_trees. It must only be compared to tt._tree.
1085
return _PreviewTree(self)
1088
class TreeTransform(TreeTransformBase):
1089
"""Represent a tree transformation.
1091
This object is designed to support incremental generation of the transform,
1094
However, it gives optimum performance when parent directories are created
1095
before their contents. The transform is then able to put child files
1096
directly in their parent directory, avoiding later renames.
1098
It is easy to produce malformed transforms, but they are generally
1099
harmless. Attempting to apply a malformed transform will cause an
1100
exception to be raised before any modifications are made to the tree.
1102
Many kinds of malformed transforms can be corrected with the
1103
resolve_conflicts function. The remaining ones indicate programming error,
1104
such as trying to create a file with no path.
1106
Two sets of file creation methods are supplied. Convenience methods are:
1111
These are composed of the low-level methods:
1113
* create_file or create_directory or create_symlink
1117
Transform/Transaction ids
1118
-------------------------
1119
trans_ids are temporary ids assigned to all files involved in a transform.
1120
It's possible, even common, that not all files in the Tree have trans_ids.
1122
trans_ids are used because filenames and file_ids are not good enough
1123
identifiers; filenames change, and not all files have file_ids. File-ids
1124
are also associated with trans-ids, so that moving a file moves its
1127
trans_ids are only valid for the TreeTransform that generated them.
1131
Limbo is a temporary directory use to hold new versions of files.
1132
Files are added to limbo by create_file, create_directory, create_symlink,
1133
and their convenience variants (new_*). Files may be removed from limbo
1134
using cancel_creation. Files are renamed from limbo into their final
1135
location as part of TreeTransform.apply
1137
Limbo must be cleaned up, by either calling TreeTransform.apply or
1138
calling TreeTransform.finalize.
1140
Files are placed into limbo inside their parent directories, where
1141
possible. This reduces subsequent renames, and makes operations involving
1142
lots of files faster. This optimization is only possible if the parent
1143
directory is created *before* creating any of its children, so avoid
1144
creating children before parents, where possible.
1148
This temporary directory is used by _FileMover for storing files that are
1149
about to be deleted. In case of rollback, the files will be restored.
1150
FileMover does not delete files until it is sure that a rollback will not
1153
def __init__(self, tree, pb=DummyProgress()):
1154
"""Note: a tree_write lock is taken on the tree.
1156
Use TreeTransform.finalize() to release the lock (can be omitted if
1157
TreeTransform.apply() called).
1159
tree.lock_tree_write()
1162
limbodir = urlutils.local_path_from_url(
1163
tree._transport.abspath('limbo'))
1167
if e.errno == errno.EEXIST:
1168
raise ExistingLimbo(limbodir)
1169
deletiondir = urlutils.local_path_from_url(
1170
tree._transport.abspath('pending-deletion'))
1172
os.mkdir(deletiondir)
1174
if e.errno == errno.EEXIST:
1175
raise errors.ExistingPendingDeletion(deletiondir)
1180
TreeTransformBase.__init__(self, tree, limbodir, pb,
1181
tree.case_sensitive)
1182
self._deletiondir = deletiondir
1184
def apply(self, no_conflicts=False, precomputed_delta=None, _mover=None):
1185
"""Apply all changes to the inventory and filesystem.
1187
If filesystem or inventory conflicts are present, MalformedTransform
1190
If apply succeeds, finalize is not necessary.
1192
:param no_conflicts: if True, the caller guarantees there are no
1193
conflicts, so no check is made.
1194
:param precomputed_delta: An inventory delta to use instead of
1196
:param _mover: Supply an alternate FileMover, for testing
1198
if not no_conflicts:
1199
conflicts = self.find_conflicts()
1200
if len(conflicts) != 0:
1201
raise MalformedTransform(conflicts=conflicts)
1202
if precomputed_delta is None:
1203
new_inventory_delta = []
1204
inventory_delta = new_inventory_delta
1206
new_inventory_delta = None
1207
inventory_delta = precomputed_delta
1208
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1211
mover = _FileMover()
1215
child_pb.update('Apply phase', 0, 2)
1216
self._apply_removals(new_inventory_delta, mover)
1217
child_pb.update('Apply phase', 1, 2)
1218
modified_paths = self._apply_insertions(new_inventory_delta,
1224
mover.apply_deletions()
1227
self._tree.apply_inventory_delta(inventory_delta)
1230
return _TransformResults(modified_paths, self.rename_count)
1232
def _apply_removals(self, inventory_delta, mover):
1233
"""Perform tree operations that remove directory/inventory names.
1235
That is, delete files that are to be deleted, and put any files that
1236
need renaming into limbo. This must be done in strict child-to-parent
1239
If inventory_delta is None, no inventory delta generation is performed.
1241
tree_paths = list(self._tree_path_ids.iteritems())
1242
tree_paths.sort(reverse=True)
1243
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1245
for num, data in enumerate(tree_paths):
1246
path, trans_id = data
1247
child_pb.update('removing file', num, len(tree_paths))
1248
full_path = self._tree.abspath(path)
1249
if trans_id in self._removed_contents:
1250
mover.pre_delete(full_path, os.path.join(self._deletiondir,
1252
elif trans_id in self._new_name or trans_id in \
1255
mover.rename(full_path, self._limbo_name(trans_id))
1257
if e.errno != errno.ENOENT:
1260
self.rename_count += 1
1261
if (trans_id in self._removed_id
1262
and inventory_delta is not None):
1263
if trans_id == self._new_root:
1264
file_id = self._tree.get_root_id()
1266
file_id = self.tree_file_id(trans_id)
1267
# File-id isn't really being deleted, just moved
1268
if file_id in self._r_new_id:
1270
inventory_delta.append((path, None, file_id, None))
1274
def _apply_insertions(self, inventory_delta, mover):
1275
"""Perform tree operations that insert directory/inventory names.
1277
That is, create any files that need to be created, and restore from
1278
limbo any files that needed renaming. This must be done in strict
1279
parent-to-child order.
1281
If inventory_delta is None, no inventory delta is calculated, and
1282
no list of modified paths is returned.
1284
new_paths = self.new_paths(filesystem_only=(inventory_delta is None))
1287
new_path_file_ids = dict((t, self.final_file_id(t)) for p, t in
1289
if inventory_delta is not None:
1290
entries = self._tree.iter_entries_by_dir(
1291
new_path_file_ids.values())
1292
old_paths = dict((e.file_id, p) for p, e in entries)
1293
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1295
for num, (path, trans_id) in enumerate(new_paths):
1298
child_pb.update('adding file', num, len(new_paths))
1299
full_path = self._tree.abspath(path)
1300
if trans_id in self._needs_rename:
1302
mover.rename(self._limbo_name(trans_id), full_path)
1304
# We may be renaming a dangling inventory id
1305
if e.errno != errno.ENOENT:
1308
self.rename_count += 1
1309
if inventory_delta is not None:
1310
if (trans_id in self._new_contents or
1311
self.path_changed(trans_id)):
1312
if trans_id in self._new_contents:
1313
modified_paths.append(full_path)
1314
completed_new.append(trans_id)
1315
file_id = new_path_file_ids[trans_id]
1316
if file_id is not None and (trans_id in self._new_id or
1317
trans_id in self._new_name or
1318
trans_id in self._new_parent
1319
or trans_id in self._new_executability):
1321
kind = self.final_kind(trans_id)
1323
kind = self._tree.stored_kind(file_id)
1324
parent_trans_id = self.final_parent(trans_id)
1325
parent_file_id = new_path_file_ids.get(parent_trans_id)
1326
if parent_file_id is None:
1327
parent_file_id = self.final_file_id(
1329
if trans_id in self._new_reference_revision:
1330
new_entry = inventory.TreeReference(
1332
self._new_name[trans_id],
1333
self.final_file_id(self._new_parent[trans_id]),
1334
None, self._new_reference_revision[trans_id])
1336
new_entry = inventory.make_entry(kind,
1337
self.final_name(trans_id),
1338
parent_file_id, file_id)
1339
old_path = old_paths.get(new_entry.file_id)
1340
inventory_delta.append(
1341
(old_path, path, new_entry.file_id, new_entry))
1343
if trans_id in self._new_executability:
1344
self._set_executability(path, new_entry, trans_id)
1347
if inventory_delta is None:
1348
self._new_contents.clear()
1350
for trans_id in completed_new:
1351
del self._new_contents[trans_id]
1352
return modified_paths
1355
class TransformPreview(TreeTransformBase):
1356
"""A TreeTransform for generating preview trees.
1358
Unlike TreeTransform, this version works when the input tree is a
1359
RevisionTree, rather than a WorkingTree. As a result, it tends to ignore
1360
unversioned files in the input tree.
1363
def __init__(self, tree, pb=DummyProgress(), case_sensitive=True):
1365
limbodir = tempfile.mkdtemp(prefix='bzr-limbo-')
1366
TreeTransformBase.__init__(self, tree, limbodir, pb, case_sensitive)
1368
def canonical_path(self, path):
1371
def tree_kind(self, trans_id):
1372
path = self._tree_id_paths.get(trans_id)
1374
raise NoSuchFile(None)
1375
file_id = self._tree.path2id(path)
1376
return self._tree.kind(file_id)
1378
def _set_mode(self, trans_id, mode_id, typefunc):
1379
"""Set the mode of new file contents.
1380
The mode_id is the existing file to get the mode from (often the same
1381
as trans_id). The operation is only performed if there's a mode match
1382
according to typefunc.
1384
# is it ok to ignore this? probably
1387
def iter_tree_children(self, parent_id):
1388
"""Iterate through the entry's tree children, if any"""
1390
path = self._tree_id_paths[parent_id]
1393
file_id = self.tree_file_id(parent_id)
1396
children = getattr(self._tree.inventory[file_id], 'children', {})
1397
for child in children:
1398
childpath = joinpath(path, child)
1399
yield self.trans_id_tree_path(childpath)
1402
class _PreviewTree(tree.Tree):
1403
"""Partial implementation of Tree to support show_diff_trees"""
1405
def __init__(self, transform):
1406
self._transform = transform
1407
self._final_paths = FinalPaths(transform)
1408
self.__by_parent = None
1410
def _changes(self, file_id):
1411
for changes in self._transform.iter_changes():
1412
if changes[0] == file_id:
1415
def _content_change(self, file_id):
1416
"""Return True if the content of this file changed"""
1417
changes = self._changes(file_id)
1418
# changes[2] is true if the file content changed. See
1419
# InterTree.iter_changes.
1420
return (changes is not None and changes[2])
1422
def _get_file_revision(self, file_id, vf, tree_revision):
1423
return self._transform._tree._get_file_revision(file_id, vf,
1426
def _stat_limbo_file(self, file_id):
1427
trans_id = self._transform.trans_id_file_id(file_id)
1428
name = self._transform._limbo_name(trans_id)
1429
return os.lstat(name)
1432
def _by_parent(self):
1433
if self.__by_parent is None:
1434
self.__by_parent = self._transform.by_parent()
1435
return self.__by_parent
1437
def lock_read(self):
1438
# Perhaps in theory, this should lock the TreeTransform?
1445
def inventory(self):
1446
"""This Tree does not use inventory as its backing data."""
1447
raise NotImplementedError(_PreviewTree.inventory)
1449
def get_root_id(self):
1450
return self._transform.final_file_id(self._transform.root)
1452
def all_file_ids(self):
1453
tree_ids = set(self._transform._tree.all_file_ids())
1454
tree_ids.difference_update(self._transform.tree_file_id(t)
1455
for t in self._transform._removed_id)
1456
tree_ids.update(self._transform._new_id.values())
1460
return iter(self.all_file_ids())
1462
def paths2ids(self, specific_files, trees=None, require_versioned=False):
1463
"""See Tree.paths2ids"""
1464
to_find = set(specific_files)
1466
for (file_id, paths, changed, versioned, parent, name, kind,
1467
executable) in self._transform.iter_changes():
1468
if paths[1] in to_find:
1469
result.append(file_id)
1470
to_find.remove(paths[1])
1471
result.update(self._transform._tree.paths2ids(to_find,
1472
trees=[], require_versioned=require_versioned))
1475
def _path2trans_id(self, path):
1476
segments = splitpath(path)
1477
cur_parent = self._transform.root
1478
for cur_segment in segments:
1479
for child in self._all_children(cur_parent):
1480
if self._transform.final_name(child) == cur_segment:
1487
def path2id(self, path):
1488
return self._transform.final_file_id(self._path2trans_id(path))
1490
def id2path(self, file_id):
1491
trans_id = self._transform.trans_id_file_id(file_id)
1493
return self._final_paths._determine_path(trans_id)
1495
raise errors.NoSuchId(self, file_id)
1497
def _all_children(self, trans_id):
1498
children = set(self._transform.iter_tree_children(trans_id))
1499
# children in the _new_parent set are provided by _by_parent.
1500
children.difference_update(self._transform._new_parent.keys())
1501
children.update(self._by_parent.get(trans_id, []))
1504
def _make_inv_entries(self, ordered_entries, specific_file_ids):
1505
for trans_id, parent_file_id in ordered_entries:
1506
file_id = self._transform.final_file_id(trans_id)
1509
if (specific_file_ids is not None
1510
and file_id not in specific_file_ids):
1513
kind = self._transform.final_kind(trans_id)
1515
kind = self._transform._tree.stored_kind(file_id)
1516
new_entry = inventory.make_entry(
1518
self._transform.final_name(trans_id),
1519
parent_file_id, file_id)
1520
yield new_entry, trans_id
1522
def iter_entries_by_dir(self, specific_file_ids=None):
1523
# This may not be a maximally efficient implementation, but it is
1524
# reasonably straightforward. An implementation that grafts the
1525
# TreeTransform changes onto the tree's iter_entries_by_dir results
1526
# might be more efficient, but requires tricky inferences about stack
1528
todo = [ROOT_PARENT]
1530
while len(todo) > 0:
1532
parent_file_id = self._transform.final_file_id(parent)
1533
children = list(self._all_children(parent))
1534
paths = dict(zip(children, self._final_paths.get_paths(children)))
1535
children.sort(key=paths.get)
1536
todo.extend(reversed(children))
1537
for trans_id in children:
1538
ordered_ids.append((trans_id, parent_file_id))
1539
for entry, trans_id in self._make_inv_entries(ordered_ids,
1541
yield unicode(self._final_paths.get_path(trans_id)), entry
1543
def kind(self, file_id):
1544
trans_id = self._transform.trans_id_file_id(file_id)
1545
return self._transform.final_kind(trans_id)
1547
def stored_kind(self, file_id):
1548
trans_id = self._transform.trans_id_file_id(file_id)
1550
return self._transform._new_contents[trans_id]
1552
return self._transform._tree.stored_kind(file_id)
1554
def get_file_mtime(self, file_id, path=None):
1555
"""See Tree.get_file_mtime"""
1556
if not self._content_change(file_id):
1557
return self._transform._tree.get_file_mtime(file_id, path)
1558
return self._stat_limbo_file(file_id).st_mtime
1560
def get_file_size(self, file_id):
1561
"""See Tree.get_file_size"""
1562
if self.kind(file_id) == 'file':
1563
return self._transform._tree.get_file_size(file_id)
1567
def get_file_sha1(self, file_id, path=None, stat_value=None):
1568
return self._transform._tree.get_file_sha1(file_id)
1570
def is_executable(self, file_id, path=None):
1571
trans_id = self._transform.trans_id_file_id(file_id)
1573
return self._transform._new_executability[trans_id]
1575
return self._transform._tree.is_executable(file_id, path)
1577
def path_content_summary(self, path):
1578
trans_id = self._path2trans_id(path)
1579
tt = self._transform
1580
tree_path = tt._tree_id_paths.get(trans_id)
1581
kind = tt._new_contents.get(trans_id)
1583
if tree_path is None or trans_id in tt._removed_contents:
1584
return 'missing', None, None, None
1585
summary = tt._tree.path_content_summary(tree_path)
1586
kind, size, executable, link_or_sha1 = summary
1589
limbo_name = tt._limbo_name(trans_id)
1590
if trans_id in tt._new_reference_revision:
1591
kind = 'tree-reference'
1593
statval = os.lstat(limbo_name)
1594
size = statval.st_size
1595
if not supports_executable():
1598
executable = statval.st_mode & S_IEXEC
1602
if kind == 'symlink':
1603
link_or_sha1 = os.readlink(limbo_name)
1604
if supports_executable():
1605
executable = tt._new_executability.get(trans_id, executable)
1606
return kind, size, executable, link_or_sha1
1608
def iter_changes(self, from_tree, include_unchanged=False,
1609
specific_files=None, pb=None, extra_trees=None,
1610
require_versioned=True, want_unversioned=False):
1611
"""See InterTree.iter_changes.
1613
This implementation does not support include_unchanged, specific_files,
1614
or want_unversioned. extra_trees, require_versioned, and pb are
1617
if from_tree is not self._transform._tree:
1618
raise ValueError('from_tree must be transform source tree.')
1619
if include_unchanged:
1620
raise ValueError('include_unchanged is not supported')
1621
if specific_files is not None:
1622
raise ValueError('specific_files is not supported')
1623
if want_unversioned:
1624
raise ValueError('want_unversioned is not supported')
1625
return self._transform.iter_changes()
1627
def get_file(self, file_id, path=None):
1628
"""See Tree.get_file"""
1629
if not self._content_change(file_id):
1630
return self._transform._tree.get_file(file_id, path)
1631
trans_id = self._transform.trans_id_file_id(file_id)
1632
name = self._transform._limbo_name(trans_id)
1633
return open(name, 'rb')
1635
def get_file_text(self, file_id):
1636
text_file = self.get_file(file_id)
1638
return text_file.read()
1642
def annotate_iter(self, file_id,
1643
default_revision=_mod_revision.CURRENT_REVISION):
1644
changes = self._changes(file_id)
1648
changed_content, versioned, kind = (changes[2], changes[3],
1652
get_old = (kind[0] == 'file' and versioned[0])
1654
old_annotation = self._transform._tree.annotate_iter(file_id,
1655
default_revision=default_revision)
1659
return old_annotation
1660
if not changed_content:
1661
return old_annotation
1662
return annotate.reannotate([old_annotation],
1663
self.get_file(file_id).readlines(),
1666
def get_symlink_target(self, file_id):
1667
"""See Tree.get_symlink_target"""
1668
if not self._content_change(file_id):
1669
return self._transform._tree.get_symlink_target(file_id)
1670
trans_id = self._transform.trans_id_file_id(file_id)
1671
name = self._transform._limbo_name(trans_id)
1672
return os.readlink(name)
1674
def list_files(self, include_root=False):
1675
return self._transform._tree.list_files(include_root)
1677
def walkdirs(self, prefix=""):
1678
return self._transform._tree.walkdirs(prefix)
1680
def get_parent_ids(self):
1681
return self._transform._tree.get_parent_ids()
1683
def get_revision_tree(self, revision_id):
1684
return self._transform._tree.get_revision_tree(revision_id)
1687
def joinpath(parent, child):
1688
"""Join tree-relative paths, handling the tree root specially"""
1689
if parent is None or parent == "":
1692
return pathjoin(parent, child)
1695
class FinalPaths(object):
1696
"""Make path calculation cheap by memoizing paths.
1698
The underlying tree must not be manipulated between calls, or else
1699
the results will likely be incorrect.
1701
def __init__(self, transform):
1702
object.__init__(self)
1703
self._known_paths = {}
1704
self.transform = transform
1706
def _determine_path(self, trans_id):
1707
if trans_id == self.transform.root:
1709
name = self.transform.final_name(trans_id)
1710
parent_id = self.transform.final_parent(trans_id)
1711
if parent_id == self.transform.root:
1714
return pathjoin(self.get_path(parent_id), name)
1716
def get_path(self, trans_id):
1717
"""Find the final path associated with a trans_id"""
1718
if trans_id not in self._known_paths:
1719
self._known_paths[trans_id] = self._determine_path(trans_id)
1720
return self._known_paths[trans_id]
1722
def get_paths(self, trans_ids):
1723
return [(self.get_path(t), t) for t in trans_ids]
1727
def topology_sorted_ids(tree):
1728
"""Determine the topological order of the ids in a tree"""
1729
file_ids = list(tree)
1730
file_ids.sort(key=tree.id2path)
1734
def build_tree(tree, wt, accelerator_tree=None, hardlink=False,
1735
delta_from_tree=False):
1736
"""Create working tree for a branch, using a TreeTransform.
1738
This function should be used on empty trees, having a tree root at most.
1739
(see merge and revert functionality for working with existing trees)
1741
Existing files are handled like so:
1743
- Existing bzrdirs take precedence over creating new items. They are
1744
created as '%s.diverted' % name.
1745
- Otherwise, if the content on disk matches the content we are building,
1746
it is silently replaced.
1747
- Otherwise, conflict resolution will move the old file to 'oldname.moved'.
1749
:param tree: The tree to convert wt into a copy of
1750
:param wt: The working tree that files will be placed into
1751
:param accelerator_tree: A tree which can be used for retrieving file
1752
contents more quickly than tree itself, i.e. a workingtree. tree
1753
will be used for cases where accelerator_tree's content is different.
1754
:param hardlink: If true, hard-link files to accelerator_tree, where
1755
possible. accelerator_tree must implement abspath, i.e. be a
1757
:param delta_from_tree: If true, build_tree may use the input Tree to
1758
generate the inventory delta.
1760
wt.lock_tree_write()
1764
if accelerator_tree is not None:
1765
accelerator_tree.lock_read()
1767
return _build_tree(tree, wt, accelerator_tree, hardlink,
1770
if accelerator_tree is not None:
1771
accelerator_tree.unlock()
1778
def _build_tree(tree, wt, accelerator_tree, hardlink, delta_from_tree):
1779
"""See build_tree."""
1780
for num, _unused in enumerate(wt.all_file_ids()):
1781
if num > 0: # more than just a root
1782
raise errors.WorkingTreeAlreadyPopulated(base=wt.basedir)
1783
existing_files = set()
1784
for dir, files in wt.walkdirs():
1785
existing_files.update(f[0] for f in files)
1787
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1788
pp = ProgressPhase("Build phase", 2, top_pb)
1789
if tree.inventory.root is not None:
1790
# This is kind of a hack: we should be altering the root
1791
# as part of the regular tree shape diff logic.
1792
# The conditional test here is to avoid doing an
1793
# expensive operation (flush) every time the root id
1794
# is set within the tree, nor setting the root and thus
1795
# marking the tree as dirty, because we use two different
1796
# idioms here: tree interfaces and inventory interfaces.
1797
if wt.get_root_id() != tree.get_root_id():
1798
wt.set_root_id(tree.get_root_id())
1800
tt = TreeTransform(wt)
1804
file_trans_id[wt.get_root_id()] = \
1805
tt.trans_id_tree_file_id(wt.get_root_id())
1806
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1808
deferred_contents = []
1810
total = len(tree.inventory)
1812
precomputed_delta = []
1814
precomputed_delta = None
1815
for num, (tree_path, entry) in \
1816
enumerate(tree.inventory.iter_entries_by_dir()):
1817
pb.update("Building tree", num - len(deferred_contents), total)
1818
if entry.parent_id is None:
1821
file_id = entry.file_id
1823
precomputed_delta.append((None, tree_path, file_id, entry))
1824
if tree_path in existing_files:
1825
target_path = wt.abspath(tree_path)
1826
kind = file_kind(target_path)
1827
if kind == "directory":
1829
bzrdir.BzrDir.open(target_path)
1830
except errors.NotBranchError:
1834
if (file_id not in divert and
1835
_content_match(tree, entry, file_id, kind,
1837
tt.delete_contents(tt.trans_id_tree_path(tree_path))
1838
if kind == 'directory':
1840
parent_id = file_trans_id[entry.parent_id]
1841
if entry.kind == 'file':
1842
# We *almost* replicate new_by_entry, so that we can defer
1843
# getting the file text, and get them all at once.
1844
trans_id = tt.create_path(entry.name, parent_id)
1845
file_trans_id[file_id] = trans_id
1846
tt.version_file(file_id, trans_id)
1847
executable = tree.is_executable(file_id, tree_path)
1849
tt.set_executability(executable, trans_id)
1850
deferred_contents.append((file_id, trans_id))
1852
file_trans_id[file_id] = new_by_entry(tt, entry, parent_id,
1855
new_trans_id = file_trans_id[file_id]
1856
old_parent = tt.trans_id_tree_path(tree_path)
1857
_reparent_children(tt, old_parent, new_trans_id)
1858
offset = num + 1 - len(deferred_contents)
1859
_create_files(tt, tree, deferred_contents, pb, offset,
1860
accelerator_tree, hardlink)
1864
divert_trans = set(file_trans_id[f] for f in divert)
1865
resolver = lambda t, c: resolve_checkout(t, c, divert_trans)
1866
raw_conflicts = resolve_conflicts(tt, pass_func=resolver)
1867
if len(raw_conflicts) > 0:
1868
precomputed_delta = None
1869
conflicts = cook_conflicts(raw_conflicts, tt)
1870
for conflict in conflicts:
1873
wt.add_conflicts(conflicts)
1874
except errors.UnsupportedOperation:
1876
result = tt.apply(no_conflicts=True,
1877
precomputed_delta=precomputed_delta)
1884
def _create_files(tt, tree, desired_files, pb, offset, accelerator_tree,
1886
total = len(desired_files) + offset
1887
if accelerator_tree is None:
1888
new_desired_files = desired_files
1890
iter = accelerator_tree.iter_changes(tree, include_unchanged=True)
1891
unchanged = dict((f, p[1]) for (f, p, c, v, d, n, k, e)
1892
in iter if not (c or e[0] != e[1]))
1893
new_desired_files = []
1895
for file_id, trans_id in desired_files:
1896
accelerator_path = unchanged.get(file_id)
1897
if accelerator_path is None:
1898
new_desired_files.append((file_id, trans_id))
1900
pb.update('Adding file contents', count + offset, total)
1902
tt.create_hardlink(accelerator_tree.abspath(accelerator_path),
1905
contents = accelerator_tree.get_file(file_id, accelerator_path)
1907
tt.create_file(contents, trans_id)
1912
for count, (trans_id, contents) in enumerate(tree.iter_files_bytes(
1913
new_desired_files)):
1914
tt.create_file(contents, trans_id)
1915
pb.update('Adding file contents', count + offset, total)
1918
def _reparent_children(tt, old_parent, new_parent):
1919
for child in tt.iter_tree_children(old_parent):
1920
tt.adjust_path(tt.final_name(child), new_parent, child)
1922
def _reparent_transform_children(tt, old_parent, new_parent):
1923
by_parent = tt.by_parent()
1924
for child in by_parent[old_parent]:
1925
tt.adjust_path(tt.final_name(child), new_parent, child)
1926
return by_parent[old_parent]
1928
def _content_match(tree, entry, file_id, kind, target_path):
1929
if entry.kind != kind:
1931
if entry.kind == "directory":
1933
if entry.kind == "file":
1934
if tree.get_file(file_id).read() == file(target_path, 'rb').read():
1936
elif entry.kind == "symlink":
1937
if tree.get_symlink_target(file_id) == os.readlink(target_path):
1942
def resolve_checkout(tt, conflicts, divert):
1943
new_conflicts = set()
1944
for c_type, conflict in ((c[0], c) for c in conflicts):
1945
# Anything but a 'duplicate' would indicate programmer error
1946
if c_type != 'duplicate':
1947
raise AssertionError(c_type)
1948
# Now figure out which is new and which is old
1949
if tt.new_contents(conflict[1]):
1950
new_file = conflict[1]
1951
old_file = conflict[2]
1953
new_file = conflict[2]
1954
old_file = conflict[1]
1956
# We should only get here if the conflict wasn't completely
1958
final_parent = tt.final_parent(old_file)
1959
if new_file in divert:
1960
new_name = tt.final_name(old_file)+'.diverted'
1961
tt.adjust_path(new_name, final_parent, new_file)
1962
new_conflicts.add((c_type, 'Diverted to',
1963
new_file, old_file))
1965
new_name = tt.final_name(old_file)+'.moved'
1966
tt.adjust_path(new_name, final_parent, old_file)
1967
new_conflicts.add((c_type, 'Moved existing file to',
1968
old_file, new_file))
1969
return new_conflicts
1972
def new_by_entry(tt, entry, parent_id, tree):
1973
"""Create a new file according to its inventory entry"""
1977
contents = tree.get_file(entry.file_id).readlines()
1978
executable = tree.is_executable(entry.file_id)
1979
return tt.new_file(name, parent_id, contents, entry.file_id,
1981
elif kind in ('directory', 'tree-reference'):
1982
trans_id = tt.new_directory(name, parent_id, entry.file_id)
1983
if kind == 'tree-reference':
1984
tt.set_tree_reference(entry.reference_revision, trans_id)
1986
elif kind == 'symlink':
1987
target = tree.get_symlink_target(entry.file_id)
1988
return tt.new_symlink(name, parent_id, target, entry.file_id)
1990
raise errors.BadFileKindError(name, kind)
1993
def create_by_entry(tt, entry, tree, trans_id, lines=None, mode_id=None):
1994
"""Create new file contents according to an inventory entry."""
1995
if entry.kind == "file":
1997
lines = tree.get_file(entry.file_id).readlines()
1998
tt.create_file(lines, trans_id, mode_id=mode_id)
1999
elif entry.kind == "symlink":
2000
tt.create_symlink(tree.get_symlink_target(entry.file_id), trans_id)
2001
elif entry.kind == "directory":
2002
tt.create_directory(trans_id)
2005
def create_entry_executability(tt, entry, trans_id):
2006
"""Set the executability of a trans_id according to an inventory entry"""
2007
if entry.kind == "file":
2008
tt.set_executability(entry.executable, trans_id)
2011
def get_backup_name(entry, by_parent, parent_trans_id, tt):
2012
return _get_backup_name(entry.name, by_parent, parent_trans_id, tt)
2015
def _get_backup_name(name, by_parent, parent_trans_id, tt):
2016
"""Produce a backup-style name that appears to be available"""
2020
yield "%s.~%d~" % (name, counter)
2022
for new_name in name_gen():
2023
if not tt.has_named_child(by_parent, parent_trans_id, new_name):
2027
def _entry_changes(file_id, entry, working_tree):
2028
"""Determine in which ways the inventory entry has changed.
2030
Returns booleans: has_contents, content_mod, meta_mod
2031
has_contents means there are currently contents, but they differ
2032
contents_mod means contents need to be modified
2033
meta_mod means the metadata needs to be modified
2035
cur_entry = working_tree.inventory[file_id]
2037
working_kind = working_tree.kind(file_id)
2040
has_contents = False
2043
if has_contents is True:
2044
if entry.kind != working_kind:
2045
contents_mod, meta_mod = True, False
2047
cur_entry._read_tree_state(working_tree.id2path(file_id),
2049
contents_mod, meta_mod = entry.detect_changes(cur_entry)
2050
cur_entry._forget_tree_state()
2051
return has_contents, contents_mod, meta_mod
2054
def revert(working_tree, target_tree, filenames, backups=False,
2055
pb=DummyProgress(), change_reporter=None):
2056
"""Revert a working tree's contents to those of a target tree."""
2057
target_tree.lock_read()
2058
tt = TreeTransform(working_tree, pb)
2060
pp = ProgressPhase("Revert phase", 3, pb)
2062
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2064
merge_modified = _alter_files(working_tree, target_tree, tt,
2065
child_pb, filenames, backups)
2069
child_pb = bzrlib.ui.ui_factory.nested_progress_bar()
2071
raw_conflicts = resolve_conflicts(tt, child_pb,
2072
lambda t, c: conflict_pass(t, c, target_tree))
2075
conflicts = cook_conflicts(raw_conflicts, tt)
2077
change_reporter = delta._ChangeReporter(
2078
unversioned_filter=working_tree.is_ignored)
2079
delta.report_changes(tt.iter_changes(), change_reporter)
2080
for conflict in conflicts:
2084
working_tree.set_merge_modified(merge_modified)
2086
target_tree.unlock()
2092
def _alter_files(working_tree, target_tree, tt, pb, specific_files,
2094
merge_modified = working_tree.merge_modified()
2095
change_list = target_tree.iter_changes(working_tree,
2096
specific_files=specific_files, pb=pb)
2097
if target_tree.inventory.root is None:
2104
for id_num, (file_id, path, changed_content, versioned, parent, name,
2105
kind, executable) in enumerate(change_list):
2106
if skip_root and file_id[0] is not None and parent[0] is None:
2108
trans_id = tt.trans_id_file_id(file_id)
2111
keep_content = False
2112
if kind[0] == 'file' and (backups or kind[1] is None):
2113
wt_sha1 = working_tree.get_file_sha1(file_id)
2114
if merge_modified.get(file_id) != wt_sha1:
2115
# acquire the basis tree lazily to prevent the
2116
# expense of accessing it when it's not needed ?
2117
# (Guessing, RBC, 200702)
2118
if basis_tree is None:
2119
basis_tree = working_tree.basis_tree()
2120
basis_tree.lock_read()
2121
if file_id in basis_tree:
2122
if wt_sha1 != basis_tree.get_file_sha1(file_id):
2124
elif kind[1] is None and not versioned[1]:
2126
if kind[0] is not None:
2127
if not keep_content:
2128
tt.delete_contents(trans_id)
2129
elif kind[1] is not None:
2130
parent_trans_id = tt.trans_id_file_id(parent[0])
2131
by_parent = tt.by_parent()
2132
backup_name = _get_backup_name(name[0], by_parent,
2133
parent_trans_id, tt)
2134
tt.adjust_path(backup_name, parent_trans_id, trans_id)
2135
new_trans_id = tt.create_path(name[0], parent_trans_id)
2136
if versioned == (True, True):
2137
tt.unversion_file(trans_id)
2138
tt.version_file(file_id, new_trans_id)
2139
# New contents should have the same unix perms as old
2142
trans_id = new_trans_id
2143
if kind[1] == 'directory':
2144
tt.create_directory(trans_id)
2145
elif kind[1] == 'symlink':
2146
tt.create_symlink(target_tree.get_symlink_target(file_id),
2148
elif kind[1] == 'file':
2149
deferred_files.append((file_id, (trans_id, mode_id)))
2150
if basis_tree is None:
2151
basis_tree = working_tree.basis_tree()
2152
basis_tree.lock_read()
2153
new_sha1 = target_tree.get_file_sha1(file_id)
2154
if (file_id in basis_tree and new_sha1 ==
2155
basis_tree.get_file_sha1(file_id)):
2156
if file_id in merge_modified:
2157
del merge_modified[file_id]
2159
merge_modified[file_id] = new_sha1
2161
# preserve the execute bit when backing up
2162
if keep_content and executable[0] == executable[1]:
2163
tt.set_executability(executable[1], trans_id)
2164
elif kind[1] is not None:
2165
raise AssertionError(kind[1])
2166
if versioned == (False, True):
2167
tt.version_file(file_id, trans_id)
2168
if versioned == (True, False):
2169
tt.unversion_file(trans_id)
2170
if (name[1] is not None and
2171
(name[0] != name[1] or parent[0] != parent[1])):
2173
name[1], tt.trans_id_file_id(parent[1]), trans_id)
2174
if executable[0] != executable[1] and kind[1] == "file":
2175
tt.set_executability(executable[1], trans_id)
2176
for (trans_id, mode_id), bytes in target_tree.iter_files_bytes(
2178
tt.create_file(bytes, trans_id, mode_id)
2180
if basis_tree is not None:
2182
return merge_modified
2185
def resolve_conflicts(tt, pb=DummyProgress(), pass_func=None):
2186
"""Make many conflict-resolution attempts, but die if they fail"""
2187
if pass_func is None:
2188
pass_func = conflict_pass
2189
new_conflicts = set()
2192
pb.update('Resolution pass', n+1, 10)
2193
conflicts = tt.find_conflicts()
2194
if len(conflicts) == 0:
2195
return new_conflicts
2196
new_conflicts.update(pass_func(tt, conflicts))
2197
raise MalformedTransform(conflicts=conflicts)
2202
def conflict_pass(tt, conflicts, path_tree=None):
2203
"""Resolve some classes of conflicts.
2205
:param tt: The transform to resolve conflicts in
2206
:param conflicts: The conflicts to resolve
2207
:param path_tree: A Tree to get supplemental paths from
2209
new_conflicts = set()
2210
for c_type, conflict in ((c[0], c) for c in conflicts):
2211
if c_type == 'duplicate id':
2212
tt.unversion_file(conflict[1])
2213
new_conflicts.add((c_type, 'Unversioned existing file',
2214
conflict[1], conflict[2], ))
2215
elif c_type == 'duplicate':
2216
# files that were renamed take precedence
2217
final_parent = tt.final_parent(conflict[1])
2218
if tt.path_changed(conflict[1]):
2219
existing_file, new_file = conflict[2], conflict[1]
2221
existing_file, new_file = conflict[1], conflict[2]
2222
new_name = tt.final_name(existing_file)+'.moved'
2223
tt.adjust_path(new_name, final_parent, existing_file)
2224
new_conflicts.add((c_type, 'Moved existing file to',
2225
existing_file, new_file))
2226
elif c_type == 'parent loop':
2227
# break the loop by undoing one of the ops that caused the loop
2229
while not tt.path_changed(cur):
2230
cur = tt.final_parent(cur)
2231
new_conflicts.add((c_type, 'Cancelled move', cur,
2232
tt.final_parent(cur),))
2233
tt.adjust_path(tt.final_name(cur), tt.get_tree_parent(cur), cur)
2235
elif c_type == 'missing parent':
2236
trans_id = conflict[1]
2238
tt.cancel_deletion(trans_id)
2239
new_conflicts.add(('deleting parent', 'Not deleting',
2244
tt.final_name(trans_id)
2246
if path_tree is not None:
2247
file_id = tt.final_file_id(trans_id)
2249
file_id = tt.inactive_file_id(trans_id)
2250
entry = path_tree.inventory[file_id]
2251
# special-case the other tree root (move its
2252
# children to current root)
2253
if entry.parent_id is None:
2255
moved = _reparent_transform_children(
2256
tt, trans_id, tt.root)
2258
new_conflicts.add((c_type, 'Moved to root',
2261
parent_trans_id = tt.trans_id_file_id(
2263
tt.adjust_path(entry.name, parent_trans_id,
2266
tt.create_directory(trans_id)
2267
new_conflicts.add((c_type, 'Created directory', trans_id))
2268
elif c_type == 'unversioned parent':
2269
file_id = tt.inactive_file_id(conflict[1])
2270
# special-case the other tree root (move its children instead)
2271
if path_tree and file_id in path_tree:
2272
if path_tree.inventory[file_id].parent_id is None:
2274
tt.version_file(file_id, conflict[1])
2275
new_conflicts.add((c_type, 'Versioned directory', conflict[1]))
2276
elif c_type == 'non-directory parent':
2277
parent_id = conflict[1]
2278
parent_parent = tt.final_parent(parent_id)
2279
parent_name = tt.final_name(parent_id)
2280
parent_file_id = tt.final_file_id(parent_id)
2281
new_parent_id = tt.new_directory(parent_name + '.new',
2282
parent_parent, parent_file_id)
2283
_reparent_transform_children(tt, parent_id, new_parent_id)
2284
if parent_file_id is not None:
2285
tt.unversion_file(parent_id)
2286
new_conflicts.add((c_type, 'Created directory', new_parent_id))
2287
return new_conflicts
2290
def cook_conflicts(raw_conflicts, tt):
2291
"""Generate a list of cooked conflicts, sorted by file path"""
2292
from bzrlib.conflicts import Conflict
2293
conflict_iter = iter_cook_conflicts(raw_conflicts, tt)
2294
return sorted(conflict_iter, key=Conflict.sort_key)
2297
def iter_cook_conflicts(raw_conflicts, tt):
2298
from bzrlib.conflicts import Conflict
2300
for conflict in raw_conflicts:
2301
c_type = conflict[0]
2302
action = conflict[1]
2303
modified_path = fp.get_path(conflict[2])
2304
modified_id = tt.final_file_id(conflict[2])
2305
if len(conflict) == 3:
2306
yield Conflict.factory(c_type, action=action, path=modified_path,
2307
file_id=modified_id)
2310
conflicting_path = fp.get_path(conflict[3])
2311
conflicting_id = tt.final_file_id(conflict[3])
2312
yield Conflict.factory(c_type, action=action, path=modified_path,
2313
file_id=modified_id,
2314
conflict_path=conflicting_path,
2315
conflict_file_id=conflicting_id)
2318
class _FileMover(object):
2319
"""Moves and deletes files for TreeTransform, tracking operations"""
2322
self.past_renames = []
2323
self.pending_deletions = []
2325
def rename(self, from_, to):
2326
"""Rename a file from one path to another. Functions like os.rename"""
2328
os.rename(from_, to)
2330
if e.errno in (errno.EEXIST, errno.ENOTEMPTY):
2331
raise errors.FileExists(to, str(e))
2333
self.past_renames.append((from_, to))
2335
def pre_delete(self, from_, to):
2336
"""Rename a file out of the way and mark it for deletion.
2338
Unlike os.unlink, this works equally well for files and directories.
2339
:param from_: The current file path
2340
:param to: A temporary path for the file
2342
self.rename(from_, to)
2343
self.pending_deletions.append(to)
2346
"""Reverse all renames that have been performed"""
2347
for from_, to in reversed(self.past_renames):
2348
os.rename(to, from_)
2349
# after rollback, don't reuse _FileMover
2351
pending_deletions = None
2353
def apply_deletions(self):
2354
"""Apply all marked deletions"""
2355
for path in self.pending_deletions:
2357
# after apply_deletions, don't reuse _FileMover
2359
pending_deletions = None
added
removed
bzrlib/transform.py
