/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/mutabletree.py

  • Committer: Martin
  • Date: 2017-06-05 20:48:31 UTC
  • mto: This revision was merged to the branch mainline in revision 6658.
  • Revision ID: gzlist@googlemail.com-20170605204831-20accykspjcrx0a8
Apply 2to3 dict fixer and clean up resulting mess using view helpers

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006-2011 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""MutableTree object.
 
18
 
 
19
See MutableTree for more details.
 
20
"""
 
21
 
 
22
from __future__ import absolute_import
 
23
 
 
24
from .lazy_import import lazy_import
 
25
lazy_import(globals(), """
 
26
import operator
 
27
import os
 
28
import re
 
29
 
 
30
from breezy import (
 
31
    add,
 
32
    controldir,
 
33
    errors,
 
34
    hooks,
 
35
    inventory as _mod_inventory,
 
36
    osutils,
 
37
    revisiontree,
 
38
    trace,
 
39
    transport as _mod_transport,
 
40
    tree,
 
41
    )
 
42
""")
 
43
 
 
44
from .decorators import needs_read_lock, needs_write_lock
 
45
from .sixish import (
 
46
    viewvalues,
 
47
    )
 
48
 
 
49
 
 
50
def needs_tree_write_lock(unbound):
 
51
    """Decorate unbound to take out and release a tree_write lock."""
 
52
    def tree_write_locked(self, *args, **kwargs):
 
53
        self.lock_tree_write()
 
54
        try:
 
55
            return unbound(self, *args, **kwargs)
 
56
        finally:
 
57
            self.unlock()
 
58
    tree_write_locked.__doc__ = unbound.__doc__
 
59
    tree_write_locked.__name__ = unbound.__name__
 
60
    return tree_write_locked
 
61
 
 
62
 
 
63
class MutableTree(tree.Tree):
 
64
    """A MutableTree is a specialisation of Tree which is able to be mutated.
 
65
 
 
66
    Generally speaking these mutations are only possible within a lock_write
 
67
    context, and will revert if the lock is broken abnormally - but this cannot
 
68
    be guaranteed - depending on the exact implementation of the mutable state.
 
69
 
 
70
    The most common form of Mutable Tree is WorkingTree, see breezy.workingtree.
 
71
    For tests we also have MemoryTree which is a MutableTree whose contents are
 
72
    entirely in memory.
 
73
 
 
74
    For now, we are not treating MutableTree as an interface to provide
 
75
    conformance tests for - rather we are testing MemoryTree specifically, and
 
76
    interface testing implementations of WorkingTree.
 
77
 
 
78
    A mutable tree always has an associated Branch and ControlDir object - the
 
79
    branch and bzrdir attributes.
 
80
    """
 
81
    def __init__(self, *args, **kw):
 
82
        super(MutableTree, self).__init__(*args, **kw)
 
83
        # Is this tree on a case-insensitive or case-preserving file-system?
 
84
        # Sub-classes may initialize to False if they detect they are being
 
85
        # used on media which doesn't differentiate the case of names.
 
86
        self.case_sensitive = True
 
87
 
 
88
    def is_control_filename(self, filename):
 
89
        """True if filename is the name of a control file in this tree.
 
90
 
 
91
        :param filename: A filename within the tree. This is a relative path
 
92
            from the root of this tree.
 
93
 
 
94
        This is true IF and ONLY IF the filename is part of the meta data
 
95
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
96
        on disk will not be a control file for this tree.
 
97
        """
 
98
        raise NotImplementedError(self.is_control_filename)
 
99
 
 
100
    @needs_tree_write_lock
 
101
    def add(self, files, ids=None, kinds=None):
 
102
        """Add paths to the set of versioned paths.
 
103
 
 
104
        Note that the command line normally calls smart_add instead,
 
105
        which can automatically recurse.
 
106
 
 
107
        This adds the files to the inventory, so that they will be
 
108
        recorded by the next commit.
 
109
 
 
110
        :param files: List of paths to add, relative to the base of the tree.
 
111
        :param ids: If set, use these instead of automatically generated ids.
 
112
            Must be the same length as the list of files, but may
 
113
            contain None for ids that are to be autogenerated.
 
114
        :param kinds: Optional parameter to specify the kinds to be used for
 
115
            each file.
 
116
 
 
117
        TODO: Perhaps callback with the ids and paths as they're added.
 
118
        """
 
119
        if isinstance(files, basestring):
 
120
            # XXX: Passing a single string is inconsistent and should be
 
121
            # deprecated.
 
122
            if not (ids is None or isinstance(ids, basestring)):
 
123
                raise AssertionError()
 
124
            if not (kinds is None or isinstance(kinds, basestring)):
 
125
                raise AssertionError()
 
126
            files = [files]
 
127
            if ids is not None:
 
128
                ids = [ids]
 
129
            if kinds is not None:
 
130
                kinds = [kinds]
 
131
 
 
132
        files = [path.strip('/') for path in files]
 
133
 
 
134
        if ids is None:
 
135
            ids = [None] * len(files)
 
136
        else:
 
137
            if not (len(ids) == len(files)):
 
138
                raise AssertionError()
 
139
        if kinds is None:
 
140
            kinds = [None] * len(files)
 
141
        elif not len(kinds) == len(files):
 
142
            raise AssertionError()
 
143
        for f in files:
 
144
            # generic constraint checks:
 
145
            if self.is_control_filename(f):
 
146
                raise errors.ForbiddenControlFileError(filename=f)
 
147
            fp = osutils.splitpath(f)
 
148
        # fill out file kinds for all files [not needed when we stop
 
149
        # caring about the instantaneous file kind within a uncommmitted tree
 
150
        #
 
151
        self._gather_kinds(files, kinds)
 
152
        self._add(files, ids, kinds)
 
153
 
 
154
    def add_reference(self, sub_tree):
 
155
        """Add a TreeReference to the tree, pointing at sub_tree"""
 
156
        raise errors.UnsupportedOperation(self.add_reference, self)
 
157
 
 
158
    def _add_reference(self, sub_tree):
 
159
        """Standard add_reference implementation, for use by subclasses"""
 
160
        try:
 
161
            sub_tree_path = self.relpath(sub_tree.basedir)
 
162
        except errors.PathNotChild:
 
163
            raise errors.BadReferenceTarget(self, sub_tree,
 
164
                                            'Target not inside tree.')
 
165
        sub_tree_id = sub_tree.get_root_id()
 
166
        if sub_tree_id == self.get_root_id():
 
167
            raise errors.BadReferenceTarget(self, sub_tree,
 
168
                                     'Trees have the same root id.')
 
169
        if self.has_id(sub_tree_id):
 
170
            raise errors.BadReferenceTarget(self, sub_tree,
 
171
                                            'Root id already present in tree')
 
172
        self._add([sub_tree_path], [sub_tree_id], ['tree-reference'])
 
173
 
 
174
    def _add(self, files, ids, kinds):
 
175
        """Helper function for add - updates the inventory.
 
176
 
 
177
        :param files: sequence of pathnames, relative to the tree root
 
178
        :param ids: sequence of suggested ids for the files (may be None)
 
179
        :param kinds: sequence of  inventory kinds of the files (i.e. may
 
180
            contain "tree-reference")
 
181
        """
 
182
        raise NotImplementedError(self._add)
 
183
 
 
184
    def apply_inventory_delta(self, changes):
 
185
        """Apply changes to the inventory as an atomic operation.
 
186
 
 
187
        :param changes: An inventory delta to apply to the working tree's
 
188
            inventory.
 
189
        :return None:
 
190
        :seealso Inventory.apply_delta: For details on the changes parameter.
 
191
        """
 
192
        raise NotImplementedError(self.apply_inventory_delta)
 
193
 
 
194
    @needs_write_lock
 
195
    def commit(self, message=None, revprops=None, *args, **kwargs):
 
196
        # avoid circular imports
 
197
        from breezy import commit
 
198
        possible_master_transports=[]
 
199
        revprops = commit.Commit.update_revprops(
 
200
                revprops,
 
201
                self.branch,
 
202
                kwargs.pop('authors', None),
 
203
                kwargs.get('local', False),
 
204
                possible_master_transports)
 
205
        # args for wt.commit start at message from the Commit.commit method,
 
206
        args = (message, ) + args
 
207
        for hook in MutableTree.hooks['start_commit']:
 
208
            hook(self)
 
209
        committed_id = commit.Commit().commit(working_tree=self,
 
210
            revprops=revprops,
 
211
            possible_master_transports=possible_master_transports,
 
212
            *args, **kwargs)
 
213
        post_hook_params = PostCommitHookParams(self)
 
214
        for hook in MutableTree.hooks['post_commit']:
 
215
            hook(post_hook_params)
 
216
        return committed_id
 
217
 
 
218
    def _gather_kinds(self, files, kinds):
 
219
        """Helper function for add - sets the entries of kinds."""
 
220
        raise NotImplementedError(self._gather_kinds)
 
221
 
 
222
    @needs_read_lock
 
223
    def has_changes(self, _from_tree=None):
 
224
        """Quickly check that the tree contains at least one commitable change.
 
225
 
 
226
        :param _from_tree: tree to compare against to find changes (default to
 
227
            the basis tree and is intended to be used by tests).
 
228
 
 
229
        :return: True if a change is found. False otherwise
 
230
        """
 
231
        # Check pending merges
 
232
        if len(self.get_parent_ids()) > 1:
 
233
            return True
 
234
        if _from_tree is None:
 
235
            _from_tree = self.basis_tree()
 
236
        changes = self.iter_changes(_from_tree)
 
237
        try:
 
238
            change = next(changes)
 
239
            # Exclude root (talk about black magic... --vila 20090629)
 
240
            if change[4] == (None, None):
 
241
                change = next(changes)
 
242
            return True
 
243
        except StopIteration:
 
244
            # No changes
 
245
            return False
 
246
 
 
247
    @needs_read_lock
 
248
    def check_changed_or_out_of_date(self, strict, opt_name,
 
249
                                     more_error, more_warning):
 
250
        """Check the tree for uncommitted changes and branch synchronization.
 
251
 
 
252
        If strict is None and not set in the config files, a warning is issued.
 
253
        If strict is True, an error is raised.
 
254
        If strict is False, no checks are done and no warning is issued.
 
255
 
 
256
        :param strict: True, False or None, searched in branch config if None.
 
257
 
 
258
        :param opt_name: strict option name to search in config file.
 
259
 
 
260
        :param more_error: Details about how to avoid the check.
 
261
 
 
262
        :param more_warning: Details about what is happening.
 
263
        """
 
264
        if strict is None:
 
265
            strict = self.branch.get_config_stack().get(opt_name)
 
266
        if strict is not False:
 
267
            err_class = None
 
268
            if (self.has_changes()):
 
269
                err_class = errors.UncommittedChanges
 
270
            elif self.last_revision() != self.branch.last_revision():
 
271
                # The tree has lost sync with its branch, there is little
 
272
                # chance that the user is aware of it but he can still force
 
273
                # the action with --no-strict
 
274
                err_class = errors.OutOfDateTree
 
275
            if err_class is not None:
 
276
                if strict is None:
 
277
                    err = err_class(self, more=more_warning)
 
278
                    # We don't want to interrupt the user if he expressed no
 
279
                    # preference about strict.
 
280
                    trace.warning('%s', err._format())
 
281
                else:
 
282
                    err = err_class(self, more=more_error)
 
283
                    raise err
 
284
 
 
285
    @needs_read_lock
 
286
    def last_revision(self):
 
287
        """Return the revision id of the last commit performed in this tree.
 
288
 
 
289
        In early tree formats the result of last_revision is the same as the
 
290
        branch last_revision, but that is no longer the case for modern tree
 
291
        formats.
 
292
 
 
293
        last_revision returns the left most parent id, or None if there are no
 
294
        parents.
 
295
 
 
296
        last_revision was deprecated as of 0.11. Please use get_parent_ids
 
297
        instead.
 
298
        """
 
299
        raise NotImplementedError(self.last_revision)
 
300
 
 
301
    def lock_tree_write(self):
 
302
        """Lock the working tree for write, and the branch for read.
 
303
 
 
304
        This is useful for operations which only need to mutate the working
 
305
        tree. Taking out branch write locks is a relatively expensive process
 
306
        and may fail if the branch is on read only media. So branch write locks
 
307
        should only be taken out when we are modifying branch data - such as in
 
308
        operations like commit, pull, uncommit and update.
 
309
        """
 
310
        raise NotImplementedError(self.lock_tree_write)
 
311
 
 
312
    def lock_write(self):
 
313
        """Lock the tree and its branch. This allows mutating calls to be made.
 
314
 
 
315
        Some mutating methods will take out implicit write locks, but in
 
316
        general you should always obtain a write lock before calling mutating
 
317
        methods on a tree.
 
318
        """
 
319
        raise NotImplementedError(self.lock_write)
 
320
 
 
321
    @needs_write_lock
 
322
    def mkdir(self, path, file_id=None):
 
323
        """Create a directory in the tree. if file_id is None, one is assigned.
 
324
 
 
325
        :param path: A unicode file path.
 
326
        :param file_id: An optional file-id.
 
327
        :return: the file id of the new directory.
 
328
        """
 
329
        raise NotImplementedError(self.mkdir)
 
330
 
 
331
    def _observed_sha1(self, file_id, path, sha_and_stat):
 
332
        """Tell the tree we have observed a paths sha1.
 
333
 
 
334
        The intent of this function is to allow trees that have a hashcache to
 
335
        update the hashcache during commit. If the observed file is too new
 
336
        (based on the stat_value) to be safely hash-cached the tree will ignore
 
337
        it.
 
338
 
 
339
        The default implementation does nothing.
 
340
 
 
341
        :param file_id: The file id
 
342
        :param path: The file path
 
343
        :param sha_and_stat: The sha 1 and stat result observed.
 
344
        :return: None
 
345
        """
 
346
 
 
347
    @needs_write_lock
 
348
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
349
        """Update the content of a file in the tree.
 
350
 
 
351
        Note that the file is written in-place rather than being
 
352
        written to a temporary location and renamed. As a consequence,
 
353
        readers can potentially see the file half-written.
 
354
 
 
355
        :param file_id: file-id of the file
 
356
        :param bytes: the new file contents
 
357
        """
 
358
        raise NotImplementedError(self.put_file_bytes_non_atomic)
 
359
 
 
360
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
361
        """Set the parents ids of the working tree.
 
362
 
 
363
        :param revision_ids: A list of revision_ids.
 
364
        """
 
365
        raise NotImplementedError(self.set_parent_ids)
 
366
 
 
367
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
368
        """Set the parents of the working tree.
 
369
 
 
370
        :param parents_list: A list of (revision_id, tree) tuples.
 
371
            If tree is None, then that element is treated as an unreachable
 
372
            parent tree - i.e. a ghost.
 
373
        """
 
374
        raise NotImplementedError(self.set_parent_trees)
 
375
 
 
376
    def smart_add(self, file_list, recurse=True, action=None, save=True):
 
377
        """Version file_list, optionally recursing into directories.
 
378
 
 
379
        This is designed more towards DWIM for humans than API clarity.
 
380
        For the specific behaviour see the help for cmd_add().
 
381
 
 
382
        :param file_list: List of zero or more paths.  *NB: these are 
 
383
            interpreted relative to the process cwd, not relative to the 
 
384
            tree.*  (Add and most other tree methods use tree-relative
 
385
            paths.)
 
386
        :param action: A reporter to be called with the inventory, parent_ie,
 
387
            path and kind of the path being added. It may return a file_id if
 
388
            a specific one should be used.
 
389
        :param save: Save the inventory after completing the adds. If False
 
390
            this provides dry-run functionality by doing the add and not saving
 
391
            the inventory.
 
392
        :return: A tuple - files_added, ignored_files. files_added is the count
 
393
            of added files, and ignored_files is a dict mapping files that were
 
394
            ignored to the rule that caused them to be ignored.
 
395
        """
 
396
        raise NotImplementedError(self.smart_add)
 
397
 
 
398
 
 
399
class MutableInventoryTree(MutableTree, tree.InventoryTree):
 
400
 
 
401
    @needs_tree_write_lock
 
402
    def apply_inventory_delta(self, changes):
 
403
        """Apply changes to the inventory as an atomic operation.
 
404
 
 
405
        :param changes: An inventory delta to apply to the working tree's
 
406
            inventory.
 
407
        :return None:
 
408
        :seealso Inventory.apply_delta: For details on the changes parameter.
 
409
        """
 
410
        self.flush()
 
411
        inv = self.root_inventory
 
412
        inv.apply_delta(changes)
 
413
        self._write_inventory(inv)
 
414
 
 
415
    def _fix_case_of_inventory_path(self, path):
 
416
        """If our tree isn't case sensitive, return the canonical path"""
 
417
        if not self.case_sensitive:
 
418
            path = self.get_canonical_inventory_path(path)
 
419
        return path
 
420
 
 
421
    @needs_tree_write_lock
 
422
    def smart_add(self, file_list, recurse=True, action=None, save=True):
 
423
        """Version file_list, optionally recursing into directories.
 
424
 
 
425
        This is designed more towards DWIM for humans than API clarity.
 
426
        For the specific behaviour see the help for cmd_add().
 
427
 
 
428
        :param file_list: List of zero or more paths.  *NB: these are 
 
429
            interpreted relative to the process cwd, not relative to the 
 
430
            tree.*  (Add and most other tree methods use tree-relative
 
431
            paths.)
 
432
        :param action: A reporter to be called with the inventory, parent_ie,
 
433
            path and kind of the path being added. It may return a file_id if
 
434
            a specific one should be used.
 
435
        :param save: Save the inventory after completing the adds. If False
 
436
            this provides dry-run functionality by doing the add and not saving
 
437
            the inventory.
 
438
        :return: A tuple - files_added, ignored_files. files_added is the count
 
439
            of added files, and ignored_files is a dict mapping files that were
 
440
            ignored to the rule that caused them to be ignored.
 
441
        """
 
442
        # Not all mutable trees can have conflicts
 
443
        if getattr(self, 'conflicts', None) is not None:
 
444
            # Collect all related files without checking whether they exist or
 
445
            # are versioned. It's cheaper to do that once for all conflicts
 
446
            # than trying to find the relevant conflict for each added file.
 
447
            conflicts_related = set()
 
448
            for c in self.conflicts():
 
449
                conflicts_related.update(c.associated_filenames())
 
450
        else:
 
451
            conflicts_related = None
 
452
        adder = _SmartAddHelper(self, action, conflicts_related)
 
453
        adder.add(file_list, recurse=recurse)
 
454
        if save:
 
455
            invdelta = adder.get_inventory_delta()
 
456
            self.apply_inventory_delta(invdelta)
 
457
        return adder.added, adder.ignored
 
458
 
 
459
    def update_basis_by_delta(self, new_revid, delta):
 
460
        """Update the parents of this tree after a commit.
 
461
 
 
462
        This gives the tree one parent, with revision id new_revid. The
 
463
        inventory delta is applied to the current basis tree to generate the
 
464
        inventory for the parent new_revid, and all other parent trees are
 
465
        discarded.
 
466
 
 
467
        All the changes in the delta should be changes synchronising the basis
 
468
        tree with some or all of the working tree, with a change to a directory
 
469
        requiring that its contents have been recursively included. That is,
 
470
        this is not a general purpose tree modification routine, but a helper
 
471
        for commit which is not required to handle situations that do not arise
 
472
        outside of commit.
 
473
 
 
474
        See the inventory developers documentation for the theory behind
 
475
        inventory deltas.
 
476
 
 
477
        :param new_revid: The new revision id for the trees parent.
 
478
        :param delta: An inventory delta (see apply_inventory_delta) describing
 
479
            the changes from the current left most parent revision to new_revid.
 
480
        """
 
481
        # if the tree is updated by a pull to the branch, as happens in
 
482
        # WorkingTree2, when there was no separation between branch and tree,
 
483
        # then just clear merges, efficiency is not a concern for now as this
 
484
        # is legacy environments only, and they are slow regardless.
 
485
        if self.last_revision() == new_revid:
 
486
            self.set_parent_ids([new_revid])
 
487
            return
 
488
        # generic implementation based on Inventory manipulation. See
 
489
        # WorkingTree classes for optimised versions for specific format trees.
 
490
        basis = self.basis_tree()
 
491
        basis.lock_read()
 
492
        # TODO: Consider re-evaluating the need for this with CHKInventory
 
493
        # we don't strictly need to mutate an inventory for this
 
494
        # it only makes sense when apply_delta is cheaper than get_inventory()
 
495
        inventory = _mod_inventory.mutable_inventory_from_tree(basis)
 
496
        basis.unlock()
 
497
        inventory.apply_delta(delta)
 
498
        rev_tree = revisiontree.InventoryRevisionTree(self.branch.repository,
 
499
                                             inventory, new_revid)
 
500
        self.set_parent_trees([(new_revid, rev_tree)])
 
501
 
 
502
 
 
503
class MutableTreeHooks(hooks.Hooks):
 
504
    """A dictionary mapping a hook name to a list of callables for mutabletree
 
505
    hooks.
 
506
    """
 
507
 
 
508
    def __init__(self):
 
509
        """Create the default hooks.
 
510
 
 
511
        """
 
512
        hooks.Hooks.__init__(self, "breezy.mutabletree", "MutableTree.hooks")
 
513
        self.add_hook('start_commit',
 
514
            "Called before a commit is performed on a tree. The start commit "
 
515
            "hook is able to change the tree before the commit takes place. "
 
516
            "start_commit is called with the breezy.mutabletree.MutableTree "
 
517
            "that the commit is being performed on.", (1, 4))
 
518
        self.add_hook('post_commit',
 
519
            "Called after a commit is performed on a tree. The hook is "
 
520
            "called with a breezy.mutabletree.PostCommitHookParams object. "
 
521
            "The mutable tree the commit was performed on is available via "
 
522
            "the mutable_tree attribute of that object.", (2, 0))
 
523
        self.add_hook('pre_transform',
 
524
            "Called before a tree transform on this tree. The hook is called "
 
525
            "with the tree that is being transformed and the transform.",
 
526
            (2, 5))
 
527
        self.add_hook('post_build_tree',
 
528
            "Called after a completely new tree is built. The hook is "
 
529
            "called with the tree as its only argument.", (2, 5))
 
530
        self.add_hook('post_transform',
 
531
            "Called after a tree transform has been performed on a tree. "
 
532
            "The hook is called with the tree that is being transformed and "
 
533
            "the transform.",
 
534
            (2, 5))
 
535
 
 
536
# install the default hooks into the MutableTree class.
 
537
MutableTree.hooks = MutableTreeHooks()
 
538
 
 
539
 
 
540
class PostCommitHookParams(object):
 
541
    """Parameters for the post_commit hook.
 
542
 
 
543
    To access the parameters, use the following attributes:
 
544
 
 
545
    * mutable_tree - the MutableTree object
 
546
    """
 
547
 
 
548
    def __init__(self, mutable_tree):
 
549
        """Create the parameters for the post_commit hook."""
 
550
        self.mutable_tree = mutable_tree
 
551
 
 
552
 
 
553
class _SmartAddHelper(object):
 
554
    """Helper for MutableTree.smart_add."""
 
555
 
 
556
    def get_inventory_delta(self):
 
557
        # GZ 2016-06-05: Returning view would probably be fine but currently
 
558
        # Inventory.apply_delta is documented as requiring a list of changes.
 
559
        return list(viewvalues(self._invdelta))
 
560
 
 
561
    def _get_ie(self, inv_path):
 
562
        """Retrieve the most up to date inventory entry for a path.
 
563
 
 
564
        :param inv_path: Normalized inventory path
 
565
        :return: Inventory entry (with possibly invalid .children for
 
566
            directories)
 
567
        """
 
568
        entry = self._invdelta.get(inv_path)
 
569
        if entry is not None:
 
570
            return entry[3]
 
571
        # Find a 'best fit' match if the filesystem is case-insensitive
 
572
        inv_path = self.tree._fix_case_of_inventory_path(inv_path)
 
573
        file_id = self.tree.path2id(inv_path)
 
574
        if file_id is not None:
 
575
            return self.tree.iter_entries_by_dir([file_id]).next()[1]
 
576
        return None
 
577
 
 
578
    def _convert_to_directory(self, this_ie, inv_path):
 
579
        """Convert an entry to a directory.
 
580
 
 
581
        :param this_ie: Inventory entry
 
582
        :param inv_path: Normalized path for the inventory entry
 
583
        :return: The new inventory entry
 
584
        """
 
585
        # Same as in _add_one below, if the inventory doesn't
 
586
        # think this is a directory, update the inventory
 
587
        this_ie = _mod_inventory.InventoryDirectory(
 
588
            this_ie.file_id, this_ie.name, this_ie.parent_id)
 
589
        self._invdelta[inv_path] = (inv_path, inv_path, this_ie.file_id,
 
590
            this_ie)
 
591
        return this_ie
 
592
 
 
593
    def _add_one_and_parent(self, parent_ie, path, kind, inv_path):
 
594
        """Add a new entry to the inventory and automatically add unversioned parents.
 
595
 
 
596
        :param parent_ie: Parent inventory entry if known, or None.  If
 
597
            None, the parent is looked up by name and used if present, otherwise it
 
598
            is recursively added.
 
599
        :param path: 
 
600
        :param kind: Kind of new entry (file, directory, etc)
 
601
        :param inv_path:
 
602
        :return: Inventory entry for path and a list of paths which have been added.
 
603
        """
 
604
        # Nothing to do if path is already versioned.
 
605
        # This is safe from infinite recursion because the tree root is
 
606
        # always versioned.
 
607
        inv_dirname = osutils.dirname(inv_path)
 
608
        dirname, basename = osutils.split(path)
 
609
        if parent_ie is None:
 
610
            # slower but does not need parent_ie
 
611
            this_ie = self._get_ie(inv_path)
 
612
            if this_ie is not None:
 
613
                return this_ie
 
614
            # its really not there : add the parent
 
615
            # note that the dirname use leads to some extra str copying etc but as
 
616
            # there are a limited number of dirs we can be nested under, it should
 
617
            # generally find it very fast and not recurse after that.
 
618
            parent_ie = self._add_one_and_parent(None,
 
619
                dirname, 'directory', 
 
620
                inv_dirname)
 
621
        # if the parent exists, but isn't a directory, we have to do the
 
622
        # kind change now -- really the inventory shouldn't pretend to know
 
623
        # the kind of wt files, but it does.
 
624
        if parent_ie.kind != 'directory':
 
625
            # nb: this relies on someone else checking that the path we're using
 
626
            # doesn't contain symlinks.
 
627
            parent_ie = self._convert_to_directory(parent_ie, inv_dirname)
 
628
        file_id = self.action(self.tree, parent_ie, path, kind)
 
629
        entry = _mod_inventory.make_entry(kind, basename, parent_ie.file_id,
 
630
            file_id=file_id)
 
631
        self._invdelta[inv_path] = (None, inv_path, entry.file_id, entry)
 
632
        self.added.append(inv_path)
 
633
        return entry
 
634
 
 
635
    def _gather_dirs_to_add(self, user_dirs):
 
636
        # only walk the minimal parents needed: we have user_dirs to override
 
637
        # ignores.
 
638
        prev_dir = None
 
639
 
 
640
        is_inside = osutils.is_inside_or_parent_of_any
 
641
        for path in sorted(user_dirs):
 
642
            if (prev_dir is None or not is_inside([prev_dir], path)):
 
643
                inv_path, this_ie = user_dirs[path]
 
644
                yield (path, inv_path, this_ie, None)
 
645
            prev_dir = path
 
646
 
 
647
    def __init__(self, tree, action, conflicts_related=None):
 
648
        self.tree = tree
 
649
        if action is None:
 
650
            self.action = add.AddAction()
 
651
        else:
 
652
            self.action = action
 
653
        self._invdelta = {}
 
654
        self.added = []
 
655
        self.ignored = {}
 
656
        if conflicts_related is None:
 
657
            self.conflicts_related = frozenset()
 
658
        else:
 
659
            self.conflicts_related = conflicts_related
 
660
 
 
661
    def add(self, file_list, recurse=True):
 
662
        from breezy.inventory import InventoryEntry
 
663
        if not file_list:
 
664
            # no paths supplied: add the entire tree.
 
665
            # FIXME: this assumes we are running in a working tree subdir :-/
 
666
            # -- vila 20100208
 
667
            file_list = [u'.']
 
668
 
 
669
        # expand any symlinks in the directory part, while leaving the
 
670
        # filename alone
 
671
        # only expanding if symlinks are supported avoids windows path bugs
 
672
        if osutils.has_symlinks():
 
673
            file_list = list(map(osutils.normalizepath, file_list))
 
674
 
 
675
        user_dirs = {}
 
676
        # validate user file paths and convert all paths to tree
 
677
        # relative : it's cheaper to make a tree relative path an abspath
 
678
        # than to convert an abspath to tree relative, and it's cheaper to
 
679
        # perform the canonicalization in bulk.
 
680
        for filepath in osutils.canonical_relpaths(self.tree.basedir, file_list):
 
681
            # validate user parameters. Our recursive code avoids adding new
 
682
            # files that need such validation
 
683
            if self.tree.is_control_filename(filepath):
 
684
                raise errors.ForbiddenControlFileError(filename=filepath)
 
685
 
 
686
            abspath = self.tree.abspath(filepath)
 
687
            kind = osutils.file_kind(abspath)
 
688
            # ensure the named path is added, so that ignore rules in the later
 
689
            # directory walk dont skip it.
 
690
            # we dont have a parent ie known yet.: use the relatively slower
 
691
            # inventory probing method
 
692
            inv_path, _ = osutils.normalized_filename(filepath)
 
693
            this_ie = self._get_ie(inv_path)
 
694
            if this_ie is None:
 
695
                this_ie = self._add_one_and_parent(None, filepath, kind, inv_path)
 
696
            if kind == 'directory':
 
697
                # schedule the dir for scanning
 
698
                user_dirs[filepath] = (inv_path, this_ie)
 
699
 
 
700
        if not recurse:
 
701
            # no need to walk any directories at all.
 
702
            return
 
703
 
 
704
        things_to_add = list(self._gather_dirs_to_add(user_dirs))
 
705
 
 
706
        illegalpath_re = re.compile(r'[\r\n]')
 
707
        for directory, inv_path, this_ie, parent_ie in things_to_add:
 
708
            # directory is tree-relative
 
709
            abspath = self.tree.abspath(directory)
 
710
 
 
711
            # get the contents of this directory.
 
712
 
 
713
            # find the kind of the path being added, and save stat_value
 
714
            # for reuse
 
715
            stat_value = None
 
716
            if this_ie is None:
 
717
                stat_value = osutils.file_stat(abspath)
 
718
                kind = osutils.file_kind_from_stat_mode(stat_value.st_mode)
 
719
            else:
 
720
                kind = this_ie.kind
 
721
            
 
722
            # allow AddAction to skip this file
 
723
            if self.action.skip_file(self.tree,  abspath,  kind,  stat_value):
 
724
                continue
 
725
            if not InventoryEntry.versionable_kind(kind):
 
726
                trace.warning("skipping %s (can't add file of kind '%s')",
 
727
                              abspath, kind)
 
728
                continue
 
729
            if illegalpath_re.search(directory):
 
730
                trace.warning("skipping %r (contains \\n or \\r)" % abspath)
 
731
                continue
 
732
            if directory in self.conflicts_related:
 
733
                # If the file looks like one generated for a conflict, don't
 
734
                # add it.
 
735
                trace.warning(
 
736
                    'skipping %s (generated to help resolve conflicts)',
 
737
                    abspath)
 
738
                continue
 
739
 
 
740
            if kind == 'directory' and directory != '':
 
741
                try:
 
742
                    transport = _mod_transport.get_transport_from_path(abspath)
 
743
                    controldir.ControlDirFormat.find_format(transport)
 
744
                    sub_tree = True
 
745
                except errors.NotBranchError:
 
746
                    sub_tree = False
 
747
                except errors.UnsupportedFormatError:
 
748
                    sub_tree = True
 
749
            else:
 
750
                sub_tree = False
 
751
 
 
752
            if this_ie is not None:
 
753
                pass
 
754
            elif sub_tree:
 
755
                # XXX: This is wrong; people *might* reasonably be trying to
 
756
                # add subtrees as subtrees.  This should probably only be done
 
757
                # in formats which can represent subtrees, and even then
 
758
                # perhaps only when the user asked to add subtrees.  At the
 
759
                # moment you can add them specially through 'join --reference',
 
760
                # which is perhaps reasonable: adding a new reference is a
 
761
                # special operation and can have a special behaviour.  mbp
 
762
                # 20070306
 
763
                trace.warning("skipping nested tree %r", abspath)
 
764
            else:
 
765
                this_ie = self._add_one_and_parent(parent_ie, directory, kind,
 
766
                    inv_path)
 
767
 
 
768
            if kind == 'directory' and not sub_tree:
 
769
                if this_ie.kind != 'directory':
 
770
                    this_ie = self._convert_to_directory(this_ie, inv_path)
 
771
 
 
772
                for subf in sorted(os.listdir(abspath)):
 
773
                    inv_f, _ = osutils.normalized_filename(subf)
 
774
                    # here we could use TreeDirectory rather than
 
775
                    # string concatenation.
 
776
                    subp = osutils.pathjoin(directory, subf)
 
777
                    # TODO: is_control_filename is very slow. Make it faster.
 
778
                    # TreeDirectory.is_control_filename could also make this
 
779
                    # faster - its impossible for a non root dir to have a
 
780
                    # control file.
 
781
                    if self.tree.is_control_filename(subp):
 
782
                        trace.mutter("skip control directory %r", subp)
 
783
                        continue
 
784
                    sub_invp = osutils.pathjoin(inv_path, inv_f)
 
785
                    entry = self._invdelta.get(sub_invp)
 
786
                    if entry is not None:
 
787
                        sub_ie = entry[3]
 
788
                    else:
 
789
                        sub_ie = this_ie.children.get(inv_f)
 
790
                    if sub_ie is not None:
 
791
                        # recurse into this already versioned subdir.
 
792
                        things_to_add.append((subp, sub_invp, sub_ie, this_ie))
 
793
                    else:
 
794
                        # user selection overrides ignores
 
795
                        # ignore while selecting files - if we globbed in the
 
796
                        # outer loop we would ignore user files.
 
797
                        ignore_glob = self.tree.is_ignored(subp)
 
798
                        if ignore_glob is not None:
 
799
                            self.ignored.setdefault(ignore_glob, []).append(subp)
 
800
                        else:
 
801
                            things_to_add.append((subp, sub_invp, None, this_ie))