← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

(mbp) more integrated 0.15 fixes

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/add.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
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
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
import errno
 
18
import os
 
19
from os.path import dirname
19
20
import sys
20
 
import os
21
 
 
22
 
from bzrlib import (
23
 
    osutils,
24
 
    ui, 
25
 
    )
26
 
from bzrlib.i18n import gettext
 
21
 
 
22
import bzrlib.bzrdir
 
23
import bzrlib.errors as errors
 
24
from bzrlib.inventory import InventoryEntry
 
25
from bzrlib.trace import mutter, note, warning
 
26
from bzrlib.errors import NotBranchError
 
27
import bzrlib.osutils
 
28
from bzrlib.workingtree import WorkingTree
 
29
 
 
30
 
 
31
def glob_expand_for_win32(file_list):
 
32
    if not file_list:
 
33
        return
 
34
    import glob
 
35
    expanded_file_list = []
 
36
    for possible_glob in file_list:
 
37
        glob_files = glob.glob(possible_glob)
 
38
       
 
39
        if glob_files == []:
 
40
            # special case to let the normal code path handle
 
41
            # files that do not exists
 
42
            expanded_file_list.append(possible_glob)
 
43
        else:
 
44
            expanded_file_list += glob_files
 
45
    return expanded_file_list
 
46
 
 
47
 
 
48
def _prepare_file_list(file_list):
 
49
    """Prepare a file list for use by smart_add_*."""
 
50
    if sys.platform == 'win32':
 
51
        file_list = glob_expand_for_win32(file_list)
 
52
    if not file_list:
 
53
        file_list = [u'.']
 
54
    file_list = list(file_list)
 
55
    return file_list
 
56
 
27
57
 
28
58
class AddAction(object):
29
59
    """A class which defines what action to take when adding a file."""
30
60
 
31
61
    def __init__(self, to_file=None, should_print=None):
32
 
        """Initialize an action which prints added files to an output stream.
33
 
 
34
 
        :param to_file: The stream to write into. This is expected to take
35
 
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
36
 
        :param should_print: If False, printing will be suppressed.
37
 
        """
38
62
        self._to_file = to_file
39
63
        if to_file is None:
40
64
            self._to_file = sys.stdout
42
66
        if should_print is not None:
43
67
            self.should_print = should_print
44
68
 
45
 
    def __call__(self, inv, parent_ie, path, kind, _quote=osutils.quotefn):
 
69
    def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
46
70
        """Add path to inventory.
47
71
 
48
72
        The default action does nothing.
52
76
        :param kind: The kind of the object being added.
53
77
        """
54
78
        if self.should_print:
55
 
            self._to_file.write('adding %s\n' % _quote(path))
 
79
            self._to_file.write('added %s\n' % _quote(path.raw_path))
56
80
        return None
57
81
 
58
 
    def skip_file(self, tree, path, kind, stat_value = None):
59
 
        """Test whether the given file should be skipped or not.
60
 
        
61
 
        The default action never skips. Note this is only called during
62
 
        recursive adds
63
 
        
64
 
        :param tree: The tree we are working in
65
 
        :param path: The path being added
66
 
        :param kind: The kind of object being added.
67
 
        :param stat: Stat result for this file, if available already
68
 
        :return bool. True if the file should be skipped (not added)
69
 
        """
70
 
        return False
71
 
 
72
 
 
73
 
class AddWithSkipLargeAction(AddAction):
74
 
    """A class that can decide to skip a file if it's considered too large"""
75
 
 
76
 
    # default 20 MB
77
 
    _DEFAULT_MAX_FILE_SIZE = 20000000
78
 
    _optionName = 'add.maximum_file_size'
79
 
    _maxSize = None
80
 
 
81
 
    def skip_file(self, tree, path, kind, stat_value = None):
82
 
        if kind != 'file':
83
 
            return False            
84
 
        if self._maxSize is None:
85
 
            config = tree.branch.get_config()
86
 
            self._maxSize = config.get_user_option_as_int_from_SI(
87
 
                self._optionName,  
88
 
                self._DEFAULT_MAX_FILE_SIZE)
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, self._optionName,  self._maxSize))
97
 
            return True
98
 
        return False
99
 
 
100
82
 
101
83
class AddFromBaseAction(AddAction):
102
84
    """This class will try to extract file ids from another tree."""
113
95
        file_id, base_path = self._get_base_file_id(path, parent_ie)
114
96
        if file_id is not None:
115
97
            if self.should_print:
116
 
                self._to_file.write('adding %s w/ file id from %s\n'
117
 
                                    % (path, base_path))
 
98
                self._to_file.write('added %s w/ file id from %s\n'
 
99
                                    % (path.raw_path, base_path))
118
100
        else:
119
101
            # we aren't doing anything special, so let the default
120
102
            # reporter happen
130
112
        Else, we look for an entry in the base tree with the same path.
131
113
        """
132
114
 
133
 
        if self.base_tree.has_id(parent_ie.file_id):
 
115
        if (parent_ie.file_id in self.base_tree):
134
116
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
135
 
            base_child_ie = base_parent_ie.children.get(
136
 
                osutils.basename(path))
 
117
            base_child_ie = base_parent_ie.children.get(path.base_path)
137
118
            if base_child_ie is not None:
138
119
                return (base_child_ie.file_id,
139
120
                        self.base_tree.id2path(base_child_ie.file_id))
140
 
        full_base_path = osutils.pathjoin(self.base_path, path)
 
121
        full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
141
122
        # This may return None, but it is our last attempt
142
123
        return self.base_tree.path2id(full_base_path), full_base_path
 
124
 
 
125
 
 
126
# TODO: jam 20050105 These could be used for compatibility
 
127
#       however, they bind against the current stdout, not the
 
128
#       one which exists at the time they are called, so they
 
129
#       don't work for the test suite.
 
130
# deprecated
 
131
add_action_add = AddAction()
 
132
add_action_null = add_action_add
 
133
add_action_add_and_print = AddAction(should_print=True)
 
134
add_action_print = add_action_add_and_print
 
135
 
 
136
 
 
137
def smart_add(file_list, recurse=True, action=None, save=True):
 
138
    """Add files to version, optionally recursing into directories.
 
139
 
 
140
    This is designed more towards DWIM for humans than API simplicity.
 
141
    For the specific behaviour see the help for cmd_add().
 
142
 
 
143
    Returns the number of files added.
 
144
    Please see smart_add_tree for more detail.
 
145
    """
 
146
    file_list = _prepare_file_list(file_list)
 
147
    tree = WorkingTree.open_containing(file_list[0])[0]
 
148
    return smart_add_tree(tree, file_list, recurse, action=action, save=save)
 
149
 
 
150
 
 
151
class FastPath(object):
 
152
    """A path object with fast accessors for things like basename."""
 
153
 
 
154
    __slots__ = ['raw_path', 'base_path']
 
155
 
 
156
    def __init__(self, path, base_path=None):
 
157
        """Construct a FastPath from path."""
 
158
        if base_path is None:
 
159
            self.base_path = bzrlib.osutils.basename(path)
 
160
        else:
 
161
            self.base_path = base_path
 
162
        self.raw_path = path
 
163
 
 
164
    def __cmp__(self, other):
 
165
        return cmp(self.raw_path, other.raw_path)
 
166
 
 
167
    def __hash__(self):
 
168
        return hash(self.raw_path)
 
169
 
 
170
 
 
171
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
 
172
    tree.lock_tree_write()
 
173
    try:
 
174
        return _smart_add_tree(tree=tree, file_list=file_list, recurse=recurse,
 
175
                               action=action, save=save)
 
176
    finally:
 
177
        tree.unlock()
 
178
 
 
179
def _smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
 
180
    """Add files to version, optionally recursing into directories.
 
181
 
 
182
    This is designed more towards DWIM for humans than API simplicity.
 
183
    For the specific behaviour see the help for cmd_add().
 
184
 
 
185
    This calls reporter with each (path, kind, file_id) of added files.
 
186
 
 
187
    Returns the number of files added.
 
188
    
 
189
    :param save: Save the inventory after completing the adds. If False this
 
190
    provides dry-run functionality by doing the add and not saving the
 
191
    inventory.  Note that the modified inventory is left in place, allowing 
 
192
    further dry-run tasks to take place. To restore the original inventory
 
193
    call tree.read_working_inventory().
 
194
    """
 
195
    assert isinstance(recurse, bool)
 
196
    if action is None:
 
197
        action = AddAction()
 
198
    
 
199
    prepared_list = _prepare_file_list(file_list)
 
200
    mutter("smart add of %r, originally %r", prepared_list, file_list)
 
201
    inv = tree.read_working_inventory()
 
202
    added = []
 
203
    ignored = {}
 
204
    dirs_to_add = []
 
205
    user_dirs = set()
 
206
 
 
207
    # validate user file paths and convert all paths to tree 
 
208
    # relative : its cheaper to make a tree relative path an abspath
 
209
    # than to convert an abspath to tree relative.
 
210
    for filepath in prepared_list:
 
211
        rf = FastPath(tree.relpath(filepath))
 
212
        # validate user parameters. Our recursive code avoids adding new files
 
213
        # that need such validation 
 
214
        if tree.is_control_filename(rf.raw_path):
 
215
            raise errors.ForbiddenControlFileError(filename=rf.raw_path)
 
216
        
 
217
        abspath = tree.abspath(rf.raw_path)
 
218
        kind = bzrlib.osutils.file_kind(abspath)
 
219
        if kind == 'directory':
 
220
            # schedule the dir for scanning
 
221
            user_dirs.add(rf)
 
222
        else:
 
223
            if not InventoryEntry.versionable_kind(kind):
 
224
                raise errors.BadFileKindError(filename=abspath, kind=kind)
 
225
        # ensure the named path is added, so that ignore rules in the later directory
 
226
        # walk dont skip it.
 
227
        # we dont have a parent ie known yet.: use the relatively slower inventory 
 
228
        # probing method
 
229
        versioned = inv.has_filename(rf.raw_path)
 
230
        if versioned:
 
231
            continue
 
232
        added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
 
233
 
 
234
    if not recurse:
 
235
        # no need to walk any directories at all.
 
236
        if len(added) > 0 and save:
 
237
            tree._write_inventory(inv)
 
238
        return added, ignored
 
239
 
 
240
    # only walk the minimal parents needed: we have user_dirs to override
 
241
    # ignores.
 
242
    prev_dir = None
 
243
 
 
244
    is_inside = bzrlib.osutils.is_inside_or_parent_of_any
 
245
    for path in sorted(user_dirs):
 
246
        if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
 
247
            dirs_to_add.append((path, None))
 
248
        prev_dir = path.raw_path
 
249
 
 
250
    # this will eventually be *just* directories, right now it starts off with 
 
251
    # just directories.
 
252
    for directory, parent_ie in dirs_to_add:
 
253
        # directory is tree-relative
 
254
        abspath = tree.abspath(directory.raw_path)
 
255
 
 
256
        # get the contents of this directory.
 
257
 
 
258
        # find the kind of the path being added.
 
259
        kind = bzrlib.osutils.file_kind(abspath)
 
260
 
 
261
        if not InventoryEntry.versionable_kind(kind):
 
262
            warning("skipping %s (can't add file of kind '%s')", abspath, kind)
 
263
            continue
 
264
 
 
265
        if parent_ie is not None:
 
266
            versioned = directory.base_path in parent_ie.children
 
267
        else:
 
268
            # without the parent ie, use the relatively slower inventory 
 
269
            # probing method
 
270
            versioned = inv.has_filename(directory.raw_path)
 
271
 
 
272
        if kind == 'directory':
 
273
            try:
 
274
                sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
 
275
                sub_tree = True
 
276
            except NotBranchError:
 
277
                sub_tree = False
 
278
            except errors.UnsupportedFormatError:
 
279
                sub_tree = True
 
280
        else:
 
281
            sub_tree = False
 
282
 
 
283
        if directory.raw_path == '':
 
284
            # mutter("tree root doesn't need to be added")
 
285
            sub_tree = False
 
286
        elif versioned:
 
287
            pass
 
288
            # mutter("%r is already versioned", abspath)
 
289
        elif sub_tree:
 
290
            # XXX: This is wrong; people *might* reasonably be trying to add
 
291
            # subtrees as subtrees.  This should probably only be done in formats 
 
292
            # which can represent subtrees, and even then perhaps only when
 
293
            # the user asked to add subtrees.  At the moment you can add them
 
294
            # specially through 'join --reference', which is perhaps
 
295
            # reasonable: adding a new reference is a special operation and
 
296
            # can have a special behaviour.  mbp 20070306
 
297
            mutter("%r is a nested bzr tree", abspath)
 
298
        else:
 
299
            __add_one(tree, inv, parent_ie, directory, kind, action)
 
300
            added.append(directory.raw_path)
 
301
 
 
302
        if kind == 'directory' and not sub_tree:
 
303
            if parent_ie is not None:
 
304
                # must be present:
 
305
                this_ie = parent_ie.children[directory.base_path]
 
306
            else:
 
307
                # without the parent ie, use the relatively slower inventory 
 
308
                # probing method
 
309
                this_id = inv.path2id(directory.raw_path)
 
310
                if this_id is None:
 
311
                    this_ie = None
 
312
                else:
 
313
                    this_ie = inv[this_id]
 
314
 
 
315
            for subf in sorted(os.listdir(abspath)):
 
316
                # here we could use TreeDirectory rather than 
 
317
                # string concatenation.
 
318
                subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
 
319
                # TODO: is_control_filename is very slow. Make it faster. 
 
320
                # TreeDirectory.is_control_filename could also make this 
 
321
                # faster - its impossible for a non root dir to have a 
 
322
                # control file.
 
323
                if tree.is_control_filename(subp):
 
324
                    mutter("skip control directory %r", subp)
 
325
                elif subf in this_ie.children:
 
326
                    # recurse into this already versioned subdir.
 
327
                    dirs_to_add.append((FastPath(subp, subf), this_ie))
 
328
                else:
 
329
                    # user selection overrides ignoes
 
330
                    # ignore while selecting files - if we globbed in the
 
331
                    # outer loop we would ignore user files.
 
332
                    ignore_glob = tree.is_ignored(subp)
 
333
                    if ignore_glob is not None:
 
334
                        # mutter("skip ignored sub-file %r", subp)
 
335
                        ignored.setdefault(ignore_glob, []).append(subp)
 
336
                    else:
 
337
                        #mutter("queue to add sub-file %r", subp)
 
338
                        dirs_to_add.append((FastPath(subp, subf), this_ie))
 
339
 
 
340
    if len(added) > 0 and save:
 
341
        tree._write_inventory(inv)
 
342
    return added, ignored
 
343
 
 
344
 
 
345
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
 
346
    """Add a new entry to the inventory and automatically add unversioned parents.
 
347
 
 
348
    :param inv: Inventory which will receive the new entry.
 
349
    :param parent_ie: Parent inventory entry if known, or None.  If
 
350
    None, the parent is looked up by name and used if present, otherwise
 
351
    it is recursively added.
 
352
    :param kind: Kind of new entry (file, directory, etc)
 
353
    :param action: callback(inv, parent_ie, path, kind); return ignored.
 
354
    :returns: A list of paths which have been added.
 
355
    """
 
356
    # Nothing to do if path is already versioned.
 
357
    # This is safe from infinite recursion because the tree root is
 
358
    # always versioned.
 
359
    if parent_ie is not None:
 
360
        # we have a parent ie already
 
361
        added = []
 
362
    else:
 
363
        # slower but does not need parent_ie
 
364
        if inv.has_filename(path.raw_path):
 
365
            return []
 
366
        # its really not there : add the parent
 
367
        # note that the dirname use leads to some extra str copying etc but as
 
368
        # there are a limited number of dirs we can be nested under, it should
 
369
        # generally find it very fast and not recurse after that.
 
370
        added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
 
371
        parent_id = inv.path2id(dirname(path.raw_path))
 
372
        parent_ie = inv[parent_id]
 
373
    __add_one(tree, inv, parent_ie, path, kind, action)
 
374
    return added + [path.raw_path]
 
375
 
 
376
 
 
377
def __add_one(tree, inv, parent_ie, path, kind, action):
 
378
    """Add a new entry to the inventory.
 
379
 
 
380
    :param inv: Inventory which will receive the new entry.
 
381
    :param parent_ie: Parent inventory entry.
 
382
    :param kind: Kind of new entry (file, directory, etc)
 
383
    :param action: callback(inv, parent_ie, path, kind); return a file_id 
 
384
        or None to generate a new file id
 
385
    :returns: None
 
386
    """
 
387
    file_id = action(inv, parent_ie, path, kind)
 
388
    entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id,
 
389
                                        file_id=file_id)
 
390
    inv.add(entry)