~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/mutabletree.py

  • Committer: Martin Pool
  • Date: 2009-06-19 09:06:56 UTC
  • mfrom: (4463 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4464.
  • Revision ID: mbp@sourcefrog.net-20090619090656-d5weqeecyscv8kqp
merge news

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
25
25
import os
26
 
import re
27
26
 
28
27
from bzrlib import (
29
28
    add,
30
29
    bzrdir,
 
30
    hooks,
 
31
    symbol_versioning,
 
32
    )
 
33
from bzrlib.osutils import dirname
 
34
from bzrlib.revisiontree import RevisionTree
 
35
from bzrlib.trace import mutter, warning
 
36
""")
 
37
 
 
38
from bzrlib import (
31
39
    errors,
32
 
    hooks,
33
40
    osutils,
34
 
    revisiontree,
35
 
    symbol_versioning,
36
 
    trace,
37
41
    tree,
38
42
    )
39
 
""")
40
 
 
41
43
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
44
from bzrlib.osutils import splitpath
42
45
 
43
46
 
44
47
def needs_tree_write_lock(unbound):
126
129
            # generic constraint checks:
127
130
            if self.is_control_filename(f):
128
131
                raise errors.ForbiddenControlFileError(filename=f)
129
 
            fp = osutils.splitpath(f)
 
132
            fp = splitpath(f)
130
133
        # fill out file kinds for all files [not needed when we stop
131
134
        # caring about the instantaneous file kind within a uncommmitted tree
132
135
        #
223
226
            revprops=revprops,
224
227
            possible_master_transports=possible_master_transports,
225
228
            *args, **kwargs)
226
 
        post_hook_params = PostCommitHookParams(self)
227
 
        for hook in MutableTree.hooks['post_commit']:
228
 
            hook(post_hook_params)
229
229
        return committed_id
230
230
 
231
231
    def _gather_kinds(self, files, kinds):
233
233
        raise NotImplementedError(self._gather_kinds)
234
234
 
235
235
    @needs_read_lock
236
 
    def has_changes(self, _from_tree=None):
237
 
        """Quickly check that the tree contains at least one commitable change.
238
 
 
239
 
        :param _from_tree: tree to compare against to find changes (default to
240
 
            the basis tree and is intended to be used by tests).
241
 
 
242
 
        :return: True if a change is found. False otherwise
243
 
        """
244
 
        # Check pending merges
245
 
        if len(self.get_parent_ids()) > 1:
246
 
            return True
247
 
        if _from_tree is None:
248
 
            _from_tree = self.basis_tree()
249
 
        changes = self.iter_changes(_from_tree)
250
 
        try:
251
 
            change = changes.next()
252
 
            # Exclude root (talk about black magic... --vila 20090629)
253
 
            if change[4] == (None, None):
254
 
                change = changes.next()
255
 
            return True
256
 
        except StopIteration:
257
 
            # No changes
258
 
            return False
259
 
 
260
 
    @needs_read_lock
261
 
    def check_changed_or_out_of_date(self, strict, opt_name,
262
 
                                     more_error, more_warning):
263
 
        """Check the tree for uncommitted changes and branch synchronization.
264
 
 
265
 
        If strict is None and not set in the config files, a warning is issued.
266
 
        If strict is True, an error is raised.
267
 
        If strict is False, no checks are done and no warning is issued.
268
 
 
269
 
        :param strict: True, False or None, searched in branch config if None.
270
 
 
271
 
        :param opt_name: strict option name to search in config file.
272
 
 
273
 
        :param more_error: Details about how to avoid the check.
274
 
 
275
 
        :param more_warning: Details about what is happening.
276
 
        """
277
 
        if strict is None:
278
 
            strict = self.branch.get_config().get_user_option_as_bool(opt_name)
279
 
        if strict is not False:
280
 
            err_class = None
281
 
            if (self.has_changes()):
282
 
                err_class = errors.UncommittedChanges
283
 
            elif self.last_revision() != self.branch.last_revision():
284
 
                # The tree has lost sync with its branch, there is little
285
 
                # chance that the user is aware of it but he can still force
286
 
                # the action with --no-strict
287
 
                err_class = errors.OutOfDateTree
288
 
            if err_class is not None:
289
 
                if strict is None:
290
 
                    err = err_class(self, more=more_warning)
291
 
                    # We don't want to interrupt the user if he expressed no
292
 
                    # preference about strict.
293
 
                    trace.warning('%s', err._format())
294
 
                else:
295
 
                    err = err_class(self, more=more_error)
296
 
                    raise err
297
 
 
298
 
    @needs_read_lock
299
236
    def last_revision(self):
300
237
        """Return the revision id of the last commit performed in this tree.
301
238
 
418
355
 
419
356
        if not file_list:
420
357
            # no paths supplied: add the entire tree.
421
 
            # FIXME: this assumes we are running in a working tree subdir :-/
422
 
            # -- vila 20100208
423
358
            file_list = [u'.']
424
359
        # mutter("smart add of %r")
425
360
        inv = self.inventory
427
362
        ignored = {}
428
363
        dirs_to_add = []
429
364
        user_dirs = set()
430
 
        conflicts_related = set()
431
 
        # Not all mutable trees can have conflicts
432
 
        if getattr(self, 'conflicts', None) is not None:
433
 
            # Collect all related files without checking whether they exist or
434
 
            # are versioned. It's cheaper to do that once for all conflicts
435
 
            # than trying to find the relevant conflict for each added file.
436
 
            for c in self.conflicts():
437
 
                conflicts_related.update(c.associated_filenames())
438
365
 
439
366
        # validate user file paths and convert all paths to tree
440
367
        # relative : it's cheaper to make a tree relative path an abspath
442
369
        # perform the canonicalization in bulk.
443
370
        for filepath in osutils.canonical_relpaths(self.basedir, file_list):
444
371
            rf = _FastPath(filepath)
445
 
            # validate user parameters. Our recursive code avoids adding new
446
 
            # files that need such validation
 
372
            # validate user parameters. Our recursive code avoids adding new files
 
373
            # that need such validation
447
374
            if self.is_control_filename(rf.raw_path):
448
375
                raise errors.ForbiddenControlFileError(filename=rf.raw_path)
449
376
 
455
382
            else:
456
383
                if not InventoryEntry.versionable_kind(kind):
457
384
                    raise errors.BadFileKindError(filename=abspath, kind=kind)
458
 
            # ensure the named path is added, so that ignore rules in the later
459
 
            # directory walk dont skip it.
460
 
            # we dont have a parent ie known yet.: use the relatively slower
461
 
            # inventory probing method
 
385
            # ensure the named path is added, so that ignore rules in the later directory
 
386
            # walk dont skip it.
 
387
            # we dont have a parent ie known yet.: use the relatively slower inventory
 
388
            # probing method
462
389
            versioned = inv.has_filename(rf.raw_path)
463
390
            if versioned:
464
391
                continue
480
407
                dirs_to_add.append((path, None))
481
408
            prev_dir = path.raw_path
482
409
 
483
 
        illegalpath_re = re.compile(r'[\r\n]')
484
410
        # dirs_to_add is initialised to a list of directories, but as we scan
485
411
        # directories we append files to it.
486
412
        # XXX: We should determine kind of files when we scan them rather than
495
421
            kind = osutils.file_kind(abspath)
496
422
 
497
423
            if not InventoryEntry.versionable_kind(kind):
498
 
                trace.warning("skipping %s (can't add file of kind '%s')",
499
 
                              abspath, kind)
500
 
                continue
501
 
            if illegalpath_re.search(directory.raw_path):
502
 
                trace.warning("skipping %r (contains \\n or \\r)" % abspath)
503
 
                continue
504
 
            if directory.raw_path in conflicts_related:
505
 
                # If the file looks like one generated for a conflict, don't
506
 
                # add it.
507
 
                trace.warning(
508
 
                    'skipping %s (generated to help resolve conflicts)',
509
 
                    abspath)
 
424
                warning("skipping %s (can't add file of kind '%s')", abspath, kind)
510
425
                continue
511
426
 
512
427
            if parent_ie is not None:
535
450
                pass
536
451
                # mutter("%r is already versioned", abspath)
537
452
            elif sub_tree:
538
 
                # XXX: This is wrong; people *might* reasonably be trying to
539
 
                # add subtrees as subtrees.  This should probably only be done
540
 
                # in formats which can represent subtrees, and even then
541
 
                # perhaps only when the user asked to add subtrees.  At the
542
 
                # moment you can add them specially through 'join --reference',
543
 
                # which is perhaps reasonable: adding a new reference is a
544
 
                # special operation and can have a special behaviour.  mbp
545
 
                # 20070306
546
 
                trace.mutter("%r is a nested bzr tree", abspath)
 
453
                # XXX: This is wrong; people *might* reasonably be trying to add
 
454
                # subtrees as subtrees.  This should probably only be done in formats
 
455
                # which can represent subtrees, and even then perhaps only when
 
456
                # the user asked to add subtrees.  At the moment you can add them
 
457
                # specially through 'join --reference', which is perhaps
 
458
                # reasonable: adding a new reference is a special operation and
 
459
                # can have a special behaviour.  mbp 20070306
 
460
                mutter("%r is a nested bzr tree", abspath)
547
461
            else:
548
462
                _add_one(self, inv, parent_ie, directory, kind, action)
549
463
                added.append(directory.raw_path)
556
470
                    # without the parent ie, use the relatively slower inventory
557
471
                    # probing method
558
472
                    this_id = inv.path2id(
559
 
                        self._fix_case_of_inventory_path(directory.raw_path))
 
473
                            self._fix_case_of_inventory_path(directory.raw_path))
560
474
                    if this_id is None:
561
475
                        this_ie = None
562
476
                    else:
571
485
                    # faster - its impossible for a non root dir to have a
572
486
                    # control file.
573
487
                    if self.is_control_filename(subp):
574
 
                        trace.mutter("skip control directory %r", subp)
 
488
                        mutter("skip control directory %r", subp)
575
489
                    elif subf in this_ie.children:
576
490
                        # recurse into this already versioned subdir.
577
491
                        dirs_to_add.append((_FastPath(subp, subf), this_ie))
609
523
        for commit which is not required to handle situations that do not arise
610
524
        outside of commit.
611
525
 
612
 
        See the inventory developers documentation for the theory behind
613
 
        inventory deltas.
614
 
 
615
526
        :param new_revid: The new revision id for the trees parent.
616
527
        :param delta: An inventory delta (see apply_inventory_delta) describing
617
528
            the changes from the current left most parent revision to new_revid.
633
544
        inventory = basis.inventory._get_mutable_inventory()
634
545
        basis.unlock()
635
546
        inventory.apply_delta(delta)
636
 
        rev_tree = revisiontree.RevisionTree(self.branch.repository,
637
 
                                             inventory, new_revid)
 
547
        rev_tree = RevisionTree(self.branch.repository, inventory, new_revid)
638
548
        self.set_parent_trees([(new_revid, rev_tree)])
639
549
 
640
550
 
651
561
        self.create_hook(hooks.HookPoint('start_commit',
652
562
            "Called before a commit is performed on a tree. The start commit "
653
563
            "hook is able to change the tree before the commit takes place. "
654
 
            "start_commit is called with the bzrlib.mutabletree.MutableTree "
655
 
            "that the commit is being performed on.", (1, 4), None))
656
 
        self.create_hook(hooks.HookPoint('post_commit',
657
 
            "Called after a commit is performed on a tree. The hook is "
658
 
            "called with a bzrlib.mutabletree.PostCommitHookParams object. "
659
 
            "The mutable tree the commit was performed on is available via "
660
 
            "the mutable_tree attribute of that object.", (2, 0), None))
 
564
            "start_commit is called with the bzrlib.tree.MutableTree that the "
 
565
            "commit is being performed on.", (1, 4), None))
661
566
 
662
567
 
663
568
# install the default hooks into the MutableTree class.
664
569
MutableTree.hooks = MutableTreeHooks()
665
570
 
666
571
 
667
 
class PostCommitHookParams(object):
668
 
    """Parameters for the post_commit hook.
669
 
 
670
 
    To access the parameters, use the following attributes:
671
 
 
672
 
    * mutable_tree - the MutableTree object
673
 
    """
674
 
 
675
 
    def __init__(self, mutable_tree):
676
 
        """Create the parameters for the post_commit hook."""
677
 
        self.mutable_tree = mutable_tree
678
 
 
679
 
 
680
572
class _FastPath(object):
681
573
    """A path object with fast accessors for things like basename."""
682
574
 
723
615
        # there are a limited number of dirs we can be nested under, it should
724
616
        # generally find it very fast and not recurse after that.
725
617
        added = _add_one_and_parent(tree, inv, None,
726
 
            _FastPath(osutils.dirname(path.raw_path)), 'directory', action)
727
 
        parent_id = inv.path2id(osutils.dirname(path.raw_path))
 
618
            _FastPath(dirname(path.raw_path)), 'directory', action)
 
619
        parent_id = inv.path2id(dirname(path.raw_path))
728
620
        parent_ie = inv[parent_id]
729
621
    _add_one(tree, inv, parent_ie, path, kind, action)
730
622
    return added + [path.raw_path]