/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 bzrlib/add.py

  • Committer: John Arbash Meinel
  • Date: 2006-04-25 15:05:42 UTC
  • mfrom: (1185.85.85 bzr-encoding)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: john@arbash-meinel.com-20060425150542-c7b518dca9928691
[merge] the old bzr-encoding changes, reparenting them on bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
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
 
"""Helper functions for adding files to working trees."""
18
 
 
19
 
from __future__ import absolute_import
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20
16
 
21
17
import sys
22
 
import os
23
 
 
24
 
from . import (
25
 
    errors,
26
 
    osutils,
27
 
    ui,
28
 
    )
29
 
from .i18n import gettext
 
18
from os.path import dirname
 
19
 
 
20
import bzrlib.errors as errors
 
21
from bzrlib.inventory import InventoryEntry
 
22
from bzrlib.trace import mutter, note, warning
 
23
from bzrlib.errors import NotBranchError
 
24
from bzrlib.workingtree import is_control_file
 
25
import bzrlib.osutils
 
26
from bzrlib.workingtree import WorkingTree
 
27
 
 
28
def glob_expand_for_win32(file_list):
 
29
    if not file_list:
 
30
        return
 
31
    import glob
 
32
    expanded_file_list = []
 
33
    for possible_glob in file_list:
 
34
        glob_files = glob.glob(possible_glob)
 
35
       
 
36
        if glob_files == []:
 
37
            # special case to let the normal code path handle
 
38
            # files that do not exists
 
39
            expanded_file_list.append(possible_glob)
 
40
        else:
 
41
            expanded_file_list += glob_files
 
42
    return expanded_file_list
 
43
 
 
44
 
 
45
def _prepare_file_list(file_list):
 
46
    """Prepare a file list for use by smart_add_*."""
 
47
    if sys.platform == 'win32':
 
48
        file_list = glob_expand_for_win32(file_list)
 
49
    if not file_list:
 
50
        file_list = [u'.']
 
51
    file_list = list(file_list)
 
52
    return file_list
30
53
 
31
54
 
32
55
class AddAction(object):
33
56
    """A class which defines what action to take when adding a file."""
34
57
 
35
 
    def __init__(self, to_file=None, should_print=None):
36
 
        """Initialize an action which prints added files to an output stream.
 
58
    should_add = False
 
59
    should_print = False
37
60
 
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``.
40
 
        :param should_print: If False, printing will be suppressed.
41
 
        """
 
61
    def __init__(self, to_file=None, should_add=None, should_print=None):
42
62
        self._to_file = to_file
43
63
        if to_file is None:
44
64
            self._to_file = sys.stdout
45
 
        self.should_print = False
 
65
        if should_add is not None:
 
66
            self.should_add = should_add
46
67
        if should_print is not None:
47
68
            self.should_print = should_print
48
69
 
49
 
    def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
 
70
    def __call__(self, inv, path, kind):
50
71
        """Add path to inventory.
51
72
 
52
73
        The default action does nothing.
53
74
 
54
75
        :param inv: The inventory we are working with.
55
 
        :param path: The FastPath being added
 
76
        :param path: The path being added
56
77
        :param kind: The kind of the object being added.
57
78
        """
 
79
        if self.should_add:
 
80
            self._add_to_inv(inv, path, kind)
58
81
        if self.should_print:
59
 
            self._to_file.write('adding %s\n' % _quote(path))
60
 
        return None
61
 
 
62
 
    def skip_file(self, tree, path, kind, stat_value=None):
63
 
        """Test whether the given file should be skipped or not.
64
 
 
65
 
        The default action never skips. Note this is only called during
66
 
        recursive adds
67
 
 
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.
71
 
        :param stat: Stat result for this file, if available already
72
 
        :return bool. True if the file should be skipped (not added)
73
 
        """
74
 
        return False
75
 
 
76
 
 
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
 
 
82
 
    def skip_file(self, tree, path, kind, stat_value=None):
83
 
        if kind != 'file':
84
 
            return False
85
 
        opt_name = 'add.maximum_file_size'
86
 
        if self._maxSize is None:
87
 
            config = tree.get_config_stack()
88
 
            self._maxSize = config.get(opt_name)
89
 
        if stat_value is None:
90
 
            file_size = os.path.getsize(path)
91
 
        else:
92
 
            file_size = stat_value.st_size
93
 
        if self._maxSize > 0 and file_size > self._maxSize:
94
 
            ui.ui_factory.show_warning(gettext(
95
 
                "skipping {0} (larger than {1} of {2} bytes)").format(
96
 
                path, opt_name, self._maxSize))
97
 
            return True
98
 
        return False
99
 
 
100
 
 
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:
116
 
                self._to_file.write('adding %s w/ file id from %s\n'
117
 
                                    % (path, base_path))
118
 
        else:
119
 
            # we aren't doing anything special, so let the default
120
 
            # reporter happen
121
 
            file_id = super(AddFromBaseAction, self).__call__(
122
 
                inv, parent_ie, path, kind)
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
 
        """
 
82
            self._print(inv, path, kind)
 
83
 
 
84
    def _print(self, inv, path, kind):
 
85
        self._to_file.write('added ')
 
86
        self._to_file.write(bzrlib.osutils.quotefn(path))
 
87
        self._to_file.write('\n')
 
88
 
 
89
    def _add_to_inv(self, inv, path, kind):
 
90
        entry = inv.add_path(path, kind=kind)
 
91
        mutter("added %r kind %r file_id={%s}", path, kind, entry.file_id)
 
92
 
 
93
 
 
94
# TODO: jam 20050105 These could be used for compatibility
 
95
#       however, they bind against the current stdout, not the
 
96
#       one which exists at the time they are called, so they
 
97
#       don't work for the test suite.
 
98
# deprecated
 
99
add_action_null = AddAction()
 
100
add_action_add = AddAction(should_add=True)
 
101
add_action_print = AddAction(should_print=True)
 
102
add_action_add_and_print = AddAction(should_add=True, should_print=True)
 
103
 
 
104
 
 
105
def smart_add(file_list, recurse=True, action=None):
 
106
    """Add files to version, optionally recursing into directories.
 
107
 
 
108
    This is designed more towards DWIM for humans than API simplicity.
 
109
    For the specific behaviour see the help for cmd_add().
 
110
 
 
111
    Returns the number of files added.
 
112
 
 
113
    """
 
114
    file_list = _prepare_file_list(file_list)
 
115
    tree = WorkingTree.open_containing(file_list[0])[0]
 
116
    return smart_add_tree(tree, file_list, recurse, action=action)
 
117
 
 
118
 
 
119
def smart_add_tree(tree, file_list, recurse=True, action=None):
 
120
    """Add files to version, optionally recursing into directories.
 
121
 
 
122
    This is designed more towards DWIM for humans than API simplicity.
 
123
    For the specific behaviour see the help for cmd_add().
 
124
 
 
125
    This calls reporter with each (path, kind, file_id) of added files.
 
126
 
 
127
    Returns the number of files added.
 
128
    """
 
129
    import os, errno
 
130
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
 
131
    assert isinstance(recurse, bool)
 
132
    if action is None:
 
133
        action = AddAction(should_add=True)
 
134
 
 
135
    file_list = _prepare_file_list(file_list)
 
136
    user_list = file_list[:]
 
137
    inv = tree.read_working_inventory()
 
138
    added = []
 
139
    ignored = {}
 
140
 
 
141
    for f in file_list:
 
142
        rf = tree.relpath(f)
 
143
        af = tree.abspath(rf)
 
144
 
132
145
        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))
138
 
            base_id = self.base_tree.path2id(base_path)
139
 
            if base_id is not None:
140
 
                return (base_id, base_path)
141
 
        full_base_path = osutils.pathjoin(self.base_path, path)
142
 
        # This may return None, but it is our last attempt
143
 
        return self.base_tree.path2id(full_base_path), full_base_path
 
146
            kind = bzrlib.osutils.file_kind(af)
 
147
        except OSError, e:
 
148
            if hasattr(e, 'errno') and e.errno == errno.ENOENT:
 
149
                raise errors.NoSuchFile(rf)
 
150
            raise
 
151
 
 
152
        if not InventoryEntry.versionable_kind(kind):
 
153
            if f in user_list:
 
154
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
 
155
            else:
 
156
                warning("skipping %s (can't add file of kind '%s')", f, kind)
 
157
                continue
 
158
 
 
159
        mutter("smart add of %r, abs=%r", f, af)
 
160
        
 
161
        if tree.is_control_filename(af):
 
162
            raise ForbiddenFileError('cannot add control file %s' % f)
 
163
            
 
164
        versioned = (inv.path2id(rf) != None)
 
165
 
 
166
        if kind == 'directory':
 
167
            try:
 
168
                sub_branch = WorkingTree.open(af)
 
169
                sub_tree = True
 
170
            except NotBranchError:
 
171
                sub_tree = False
 
172
            except errors.UnsupportedFormatError:
 
173
                sub_tree = True
 
174
        else:
 
175
            sub_tree = False
 
176
 
 
177
        if rf == '':
 
178
            mutter("tree root doesn't need to be added")
 
179
            sub_tree = False
 
180
        elif versioned:
 
181
            mutter("%r is already versioned", f)
 
182
        elif sub_tree:
 
183
            mutter("%r is a bzr tree", f)
 
184
        else:
 
185
            added.extend(__add_one(tree, inv, rf, kind, action))
 
186
 
 
187
        if kind == 'directory' and recurse and not sub_tree:
 
188
            for subf in os.listdir(af):
 
189
                subp = bzrlib.osutils.pathjoin(rf, subf)
 
190
                if tree.is_control_filename(subp):
 
191
                    mutter("skip control directory %r", subp)
 
192
                else:
 
193
                    ignore_glob = tree.is_ignored(subp)
 
194
                    if ignore_glob is not None:
 
195
                        mutter("skip ignored sub-file %r", subp)
 
196
                        if ignore_glob not in ignored:
 
197
                            ignored[ignore_glob] = []
 
198
                        ignored[ignore_glob].append(subp)
 
199
                    else:
 
200
                        mutter("queue to add sub-file %r", subp)
 
201
                        file_list.append(tree.abspath(subp))
 
202
 
 
203
 
 
204
    mutter('added %d entries', len(added))
 
205
    
 
206
    if len(added) > 0:
 
207
        tree._write_inventory(inv)
 
208
 
 
209
    return added, ignored
 
210
 
 
211
 
 
212
def __add_one(tree, inv, path, kind, action):
 
213
    """Add a file or directory, automatically add unversioned parents."""
 
214
 
 
215
    # Nothing to do if path is already versioned.
 
216
    # This is safe from infinite recursion because the tree root is
 
217
    # always versioned.
 
218
    if inv.path2id(path) != None:
 
219
        return []
 
220
 
 
221
    # add parent
 
222
    added = __add_one(tree, inv, dirname(path), 'directory', action)
 
223
    action(inv, path, kind)
 
224
 
 
225
    return added + [path]