/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
5273.1.8 by Vincent Ladeuil
Merge bzr.dev into cleanup
1
# Copyright (C) 2005-2010 Canonical Ltd
1685.1.80 by Wouter van Heyst
more code cleanup
2
#
70 by mbp at sourcefrog
Prepare for smart recursive add.
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.
1685.1.80 by Wouter van Heyst
more code cleanup
7
#
70 by mbp at sourcefrog
Prepare for smart recursive add.
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.
1685.1.80 by Wouter van Heyst
more code cleanup
12
#
70 by mbp at sourcefrog
Prepare for smart recursive add.
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
70 by mbp at sourcefrog
Prepare for smart recursive add.
16
6379.6.7 by Jelmer Vernooij
Move importing from future until after doc string, otherwise the doc string will disappear.
17
"""Helper functions for adding files to working trees."""
18
6379.6.1 by Jelmer Vernooij
Import absolute_import in a few places.
19
from __future__ import absolute_import
20
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
21
import sys
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
22
import os
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
23
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
24
from . import (
6883.7.7 by Jelmer Vernooij
Avoid call to has_id.
25
    errors,
5870.1.43 by Jelmer Vernooij
Avoid 'import bzrlib.osutils'.
26
    osutils,
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
27
    ui,
5870.1.43 by Jelmer Vernooij
Avoid 'import bzrlib.osutils'.
28
    )
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
29
from .i18n import gettext
1685.1.80 by Wouter van Heyst
more code cleanup
30
7143.11.1 by Jelmer Vernooij
Remove some unused imports.
31
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
32
class AddAction(object):
33
    """A class which defines what action to take when adding a file."""
34
1757.2.6 by Robert Collins
Steps towards a nicer smart add - unwind the conditional add logic - having parents not in the inventory was overly complicating the rest of the code.
35
    def __init__(self, to_file=None, should_print=None):
2399.1.5 by John Arbash Meinel
Clean up add.py documentation.
36
        """Initialize an action which prints added files to an output stream.
37
38
        :param to_file: The stream to write into. This is expected to take
39
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
4031.3.1 by Frank Aspell
Fixing various typos
40
        :param should_print: If False, printing will be suppressed.
2399.1.5 by John Arbash Meinel
Clean up add.py documentation.
41
        """
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
42
        self._to_file = to_file
43
        if to_file is None:
44
            self._to_file = sys.stdout
1685.1.69 by Wouter van Heyst
merge bzr.dev 1740
45
        self.should_print = False
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
46
        if should_print is not None:
47
            self.should_print = should_print
48
5870.1.43 by Jelmer Vernooij
Avoid 'import bzrlib.osutils'.
49
    def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
50
        """Add path to inventory.
51
52
        The default action does nothing.
53
54
        :param inv: The inventory we are working with.
1757.2.2 by Robert Collins
Merge basename call eliminate for smart_add.
55
        :param path: The FastPath being added
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
56
        :param kind: The kind of the object being added.
57
        """
1911.3.1 by John Arbash Meinel
Updated smart_add so that the AddAction can return a custom id.
58
        if self.should_print:
5870.1.36 by Jelmer Vernooij
kill _FastPath.
59
            self._to_file.write('adding %s\n' % _quote(path))
1911.3.1 by John Arbash Meinel
Updated smart_add so that the AddAction can return a custom id.
60
        return None
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
61
7143.11.1 by Jelmer Vernooij
Remove some unused imports.
62
    def skip_file(self, tree, path, kind, stat_value=None):
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
63
        """Test whether the given file should be skipped or not.
7143.11.1 by Jelmer Vernooij
Remove some unused imports.
64
6046.2.9 by Shannon Weyrick
Make it explicit in docs that large file skips happen only in recursive mode. Add test.
65
        The default action never skips. Note this is only called during
66
        recursive adds
7143.11.1 by Jelmer Vernooij
Remove some unused imports.
67
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
68
        :param tree: The tree we are working in
69
        :param path: The path being added
70
        :param kind: The kind of object being added.
6046.2.7 by Shannon Weyrick
Switch add to use file_stat, and reuse stat result in AddAction
71
        :param stat: Stat result for this file, if available already
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
72
        :return bool. True if the file should be skipped (not added)
73
        """
74
        return False
75
6046.2.9 by Shannon Weyrick
Make it explicit in docs that large file skips happen only in recursive mode. Add test.
76
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
77
class AddWithSkipLargeAction(AddAction):
78
    """A class that can decide to skip a file if it's considered too large"""
79
80
    _maxSize = None
81
7143.11.1 by Jelmer Vernooij
Remove some unused imports.
82
    def skip_file(self, tree, path, kind, stat_value=None):
6046.2.8 by Shannon Weyrick
Minor cleanup
83
        if kind != 'file':
6378.1.2 by Vincent Ladeuil
Migrate add.maximum_file_size to the new config scheme
84
            return False
85
        opt_name = 'add.maximum_file_size'
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
86
        if self._maxSize is None:
6449.6.4 by Jelmer Vernooij
Use config stack.
87
            config = tree.get_config_stack()
6378.1.2 by Vincent Ladeuil
Migrate add.maximum_file_size to the new config scheme
88
            self._maxSize = config.get(opt_name)
6046.2.8 by Shannon Weyrick
Minor cleanup
89
        if stat_value is None:
7143.11.1 by Jelmer Vernooij
Remove some unused imports.
90
            file_size = os.path.getsize(path)
6046.2.7 by Shannon Weyrick
Switch add to use file_stat, and reuse stat result in AddAction
91
        else:
7143.11.1 by Jelmer Vernooij
Remove some unused imports.
92
            file_size = stat_value.st_size
6046.2.8 by Shannon Weyrick
Minor cleanup
93
        if self._maxSize > 0 and file_size > self._maxSize:
6138.3.10 by Jonathan Riddell
gettext() show_warning usage
94
            ui.ui_factory.show_warning(gettext(
6378.1.4 by Vincent Ladeuil
Restore the proper message.
95
                "skipping {0} (larger than {1} of {2} bytes)").format(
7143.11.1 by Jelmer Vernooij
Remove some unused imports.
96
                path, opt_name, self._maxSize))
6046.2.4 by Shannon Weyrick
Change AddAction interface to include a method for deciding whether to
97
            return True
98
        return False
99
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
100
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
101
class AddFromBaseAction(AddAction):
102
    """This class will try to extract file ids from another tree."""
103
104
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
105
        super(AddFromBaseAction, self).__init__(to_file=to_file,
106
                                                should_print=should_print)
107
        self.base_tree = base_tree
108
        self.base_path = base_path
109
110
    def __call__(self, inv, parent_ie, path, kind):
111
        # Place the parent call
112
        # Now check to see if we can extract an id for this file
113
        file_id, base_path = self._get_base_file_id(path, parent_ie)
114
        if file_id is not None:
115
            if self.should_print:
3985.2.3 by Daniel Watkins
Changed output of add to not suggest partial success.
116
                self._to_file.write('adding %s w/ file id from %s\n'
5870.1.36 by Jelmer Vernooij
kill _FastPath.
117
                                    % (path, base_path))
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
118
        else:
119
            # we aren't doing anything special, so let the default
120
            # reporter happen
121
            file_id = super(AddFromBaseAction, self).__call__(
7143.11.1 by Jelmer Vernooij
Remove some unused imports.
122
                inv, parent_ie, path, kind)
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
123
        return file_id
124
125
    def _get_base_file_id(self, path, parent_ie):
126
        """Look for a file id in the base branch.
127
128
        First, if the base tree has the parent directory,
129
        we look for a file with the same name in that directory.
130
        Else, we look for an entry in the base tree with the same path.
131
        """
6883.7.7 by Jelmer Vernooij
Avoid call to has_id.
132
        try:
133
            parent_path = self.base_tree.id2path(parent_ie.file_id)
134
        except errors.NoSuchId:
135
            pass
136
        else:
137
            base_path = osutils.pathjoin(parent_path, osutils.basename(path))
6471.1.2 by Jelmer Vernooij
Add Tree.iter_child_entries.
138
            base_id = self.base_tree.path2id(base_path)
139
            if base_id is not None:
140
                return (base_id, base_path)
5870.1.43 by Jelmer Vernooij
Avoid 'import bzrlib.osutils'.
141
        full_base_path = osutils.pathjoin(self.base_path, path)
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
142
        # This may return None, but it is our last attempt
143
        return self.base_tree.path2id(full_base_path), full_base_path