/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: Vincent Ladeuil
  • Date: 2007-07-03 09:28:59 UTC
  • mto: (2584.1.1 Aaron's integration)
  • mto: This revision was merged to the branch mainline in revision 2585.
  • Revision ID: v.ladeuil+lp@free.fr-20070703092859-yl7j53209tfmhf7u
Take Martin and Robert comments into account.

* bzrlib/strace.py:
(strace): is now a wrapper that calls strace_detailed.
(strace_detailed): like strace before but with an option to
disable following forked children without polluting the kwargs
param.

* bzrlib/tests/test_strace.py:
(TestStrace.test_strace_callable_is_called,
TestStrace.test_strace_callable_result,
TestStrace.test_strace_result_has_raw_log): use strace_detailed
while disabling following forked children, the syntax is a bit
uglier but non-test users should never use anyway..

Show diffs side-by-side

added added

removed removed

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