~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-07-06 03:15:29 UTC
  • mfrom: (1711.2.78 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060706031529-e189d8c3f42076be
(jam) allow plugins to include benchmarks

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""Helper functions for adding files to working trees."""
18
 
 
19
17
import errno
20
18
import os
 
19
from os.path import dirname
21
20
import sys
22
21
 
23
 
import bzrlib.bzrdir
24
22
import bzrlib.errors as errors
 
23
from bzrlib.inventory import InventoryEntry
 
24
from bzrlib.trace import mutter, note, warning
 
25
from bzrlib.errors import NotBranchError
25
26
import bzrlib.osutils
26
 
from bzrlib.symbol_versioning import *
27
27
from bzrlib.workingtree import WorkingTree
28
28
 
29
29
 
 
30
def glob_expand_for_win32(file_list):
 
31
    if not file_list:
 
32
        return
 
33
    import glob
 
34
    expanded_file_list = []
 
35
    for possible_glob in file_list:
 
36
        glob_files = glob.glob(possible_glob)
 
37
       
 
38
        if glob_files == []:
 
39
            # special case to let the normal code path handle
 
40
            # files that do not exists
 
41
            expanded_file_list.append(possible_glob)
 
42
        else:
 
43
            expanded_file_list += glob_files
 
44
    return expanded_file_list
 
45
 
 
46
 
 
47
def _prepare_file_list(file_list):
 
48
    """Prepare a file list for use by smart_add_*."""
 
49
    if sys.platform == 'win32':
 
50
        file_list = glob_expand_for_win32(file_list)
 
51
    if not file_list:
 
52
        file_list = [u'.']
 
53
    file_list = list(file_list)
 
54
    return file_list
 
55
 
 
56
 
30
57
class AddAction(object):
31
58
    """A class which defines what action to take when adding a file."""
32
59
 
33
60
    def __init__(self, to_file=None, should_print=None):
34
 
        """Initialize an action which prints added files to an output stream.
35
 
 
36
 
        :param to_file: The stream to write into. This is expected to take
37
 
            Unicode paths. If not supplied, it will default to ``sys.stdout``.
38
 
        :param should_print: If False, printing will be supressed.
39
 
        """
40
61
        self._to_file = to_file
41
62
        if to_file is None:
42
63
            self._to_file = sys.stdout
53
74
        :param path: The FastPath being added
54
75
        :param kind: The kind of the object being added.
55
76
        """
56
 
        if self.should_print:
57
 
            self._to_file.write('added %s\n' % _quote(path.raw_path))
58
 
        return None
59
 
 
60
 
 
61
 
class AddFromBaseAction(AddAction):
62
 
    """This class will try to extract file ids from another tree."""
63
 
 
64
 
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
65
 
        super(AddFromBaseAction, self).__init__(to_file=to_file,
66
 
                                                should_print=should_print)
67
 
        self.base_tree = base_tree
68
 
        self.base_path = base_path
69
 
 
70
 
    def __call__(self, inv, parent_ie, path, kind):
71
 
        # Place the parent call
72
 
        # Now check to see if we can extract an id for this file
73
 
        file_id, base_path = self._get_base_file_id(path, parent_ie)
74
 
        if file_id is not None:
75
 
            if self.should_print:
76
 
                self._to_file.write('added %s w/ file id from %s\n'
77
 
                                    % (path.raw_path, base_path))
78
 
        else:
79
 
            # we aren't doing anything special, so let the default
80
 
            # reporter happen
81
 
            file_id = super(AddFromBaseAction, self).__call__(
82
 
                        inv, parent_ie, path, kind)
83
 
        return file_id
84
 
 
85
 
    def _get_base_file_id(self, path, parent_ie):
86
 
        """Look for a file id in the base branch.
87
 
 
88
 
        First, if the base tree has the parent directory,
89
 
        we look for a file with the same name in that directory.
90
 
        Else, we look for an entry in the base tree with the same path.
91
 
        """
92
 
 
93
 
        if (parent_ie.file_id in self.base_tree):
94
 
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
95
 
            base_child_ie = base_parent_ie.children.get(path.base_path)
96
 
            if base_child_ie is not None:
97
 
                return (base_child_ie.file_id,
98
 
                        self.base_tree.id2path(base_child_ie.file_id))
99
 
        full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
100
 
        # This may return None, but it is our last attempt
101
 
        return self.base_tree.path2id(full_base_path), full_base_path
 
77
        if not self.should_print:
 
78
            return
 
79
        self._to_file.write('added %s\n' % _quote(path.raw_path))
102
80
 
103
81
 
104
82
# TODO: jam 20050105 These could be used for compatibility
112
90
add_action_print = add_action_add_and_print
113
91
 
114
92
 
115
 
@deprecated_function(zero_eighteen)
116
93
def smart_add(file_list, recurse=True, action=None, save=True):
117
94
    """Add files to version, optionally recursing into directories.
118
95
 
120
97
    For the specific behaviour see the help for cmd_add().
121
98
 
122
99
    Returns the number of files added.
123
 
    Deprecated in 0.18. Please use MutableTree.smart_add.
 
100
    Please see smart_add_tree for more detail.
124
101
    """
 
102
    file_list = _prepare_file_list(file_list)
125
103
    tree = WorkingTree.open_containing(file_list[0])[0]
126
 
    return smart_add_tree(tree, file_list, recurse, action=action, save=save)
127
 
 
128
 
 
129
 
@deprecated_function(zero_eighteen)
 
104
    return smart_add_tree(tree, file_list, recurse, action=action)
 
105
 
 
106
 
 
107
class FastPath(object):
 
108
    """A path object with fast accessors for things like basename."""
 
109
 
 
110
    __slots__ = ['raw_path', 'base_path']
 
111
 
 
112
    def __init__(self, path, base_path=None):
 
113
        """Construct a FastPath from path."""
 
114
        if base_path is None:
 
115
            self.base_path = bzrlib.osutils.basename(path)
 
116
        else:
 
117
            self.base_path = base_path
 
118
        self.raw_path = path
 
119
 
 
120
 
130
121
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
131
 
    """Deprecated in 0.18. Please use MutableTree.smart_add."""
132
 
    return tree.smart_add(file_list, recurse, action, save)
133
 
 
 
122
    """Add files to version, optionally recursing into directories.
 
123
 
 
124
    This is designed more towards DWIM for humans than API simplicity.
 
125
    For the specific behaviour see the help for cmd_add().
 
126
 
 
127
    This calls reporter with each (path, kind, file_id) of added files.
 
128
 
 
129
    Returns the number of files added.
 
130
    
 
131
    :param save: Save the inventory after completing the adds. If False this
 
132
    provides dry-run functionality by doing the add and not saving the
 
133
    inventory.  Note that the modified inventory is left in place, allowing 
 
134
    further dry-run tasks to take place. To restore the original inventory
 
135
    call tree.read_working_inventory().
 
136
    """
 
137
    assert isinstance(recurse, bool)
 
138
    if action is None:
 
139
        action = AddAction()
 
140
    
 
141
    prepared_list = _prepare_file_list(file_list)
 
142
    mutter("smart add of %r, originally %r", prepared_list, file_list)
 
143
    inv = tree.read_working_inventory()
 
144
    added = []
 
145
    ignored = {}
 
146
    dirs_to_add = []
 
147
    user_dirs = set()
 
148
 
 
149
    # validate user file paths and convert all paths to tree 
 
150
    # relative : its cheaper to make a tree relative path an abspath
 
151
    # than to convert an abspath to tree relative.
 
152
    for filepath in prepared_list:
 
153
        rf = FastPath(tree.relpath(filepath))
 
154
        # validate user parameters. Our recursive code avoids adding new files
 
155
        # that need such validation 
 
156
        if tree.is_control_filename(rf.raw_path):
 
157
            raise errors.ForbiddenControlFileError(filename=rf)
 
158
        
 
159
        abspath = tree.abspath(rf.raw_path)
 
160
        kind = bzrlib.osutils.file_kind(abspath)
 
161
        if kind == 'directory':
 
162
            # schedule the dir for scanning
 
163
            user_dirs.add(rf.raw_path)
 
164
        else:
 
165
            if not InventoryEntry.versionable_kind(kind):
 
166
                raise errors.BadFileKindError(filename=abspath, kind=kind)
 
167
        # ensure the named path is added, so that ignore rules in the later directory
 
168
        # walk dont skip it.
 
169
        # we dont have a parent ie known yet.: use the relatively slower inventory 
 
170
        # probing method
 
171
        versioned = inv.has_filename(rf.raw_path)
 
172
        if versioned:
 
173
            continue
 
174
        added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
 
175
 
 
176
    if not recurse:
 
177
        # no need to walk any directories at all.
 
178
        if len(added) > 0 and save:
 
179
            tree._write_inventory(inv)
 
180
        return added, ignored
 
181
 
 
182
    # only walk the minimal parents needed: we have user_dirs to override
 
183
    # ignores.
 
184
    prev_dir = None
 
185
    for path in sorted(user_dirs):
 
186
        if (prev_dir is None or not
 
187
            bzrlib.osutils.is_inside_or_parent_of_any([prev_dir], path)):
 
188
            dirs_to_add.append((rf, None))
 
189
        prev_dir = path
 
190
 
 
191
    # this will eventually be *just* directories, right now it starts off with 
 
192
    # just directories.
 
193
    for directory, parent_ie in dirs_to_add:
 
194
        # directory is tree-relative
 
195
        abspath = tree.abspath(directory.raw_path)
 
196
 
 
197
        # get the contents of this directory.
 
198
 
 
199
        # find the kind of the path being added.
 
200
        kind = bzrlib.osutils.file_kind(abspath)
 
201
 
 
202
        if not InventoryEntry.versionable_kind(kind):
 
203
            warning("skipping %s (can't add file of kind '%s')", abspath, kind)
 
204
            continue
 
205
 
 
206
        if parent_ie is not None:
 
207
            versioned = directory.base_path in parent_ie.children
 
208
        else:
 
209
            # without the parent ie, use the relatively slower inventory 
 
210
            # probing method
 
211
            versioned = inv.has_filename(directory.raw_path)
 
212
 
 
213
        if kind == 'directory':
 
214
            try:
 
215
                sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
 
216
                sub_tree = True
 
217
            except NotBranchError:
 
218
                sub_tree = False
 
219
            except errors.UnsupportedFormatError:
 
220
                sub_tree = True
 
221
        else:
 
222
            sub_tree = False
 
223
 
 
224
        if directory.raw_path == '':
 
225
            # mutter("tree root doesn't need to be added")
 
226
            sub_tree = False
 
227
        elif versioned:
 
228
            pass
 
229
            # mutter("%r is already versioned", abspath)
 
230
        elif sub_tree:
 
231
            mutter("%r is a nested bzr tree", abspath)
 
232
        else:
 
233
            __add_one(tree, inv, parent_ie, directory, kind, action)
 
234
            added.append(directory.raw_path)
 
235
 
 
236
        if kind == 'directory' and not sub_tree:
 
237
            if parent_ie is not None:
 
238
                # must be present:
 
239
                this_ie = parent_ie.children[directory.base_path]
 
240
            else:
 
241
                # without the parent ie, use the relatively slower inventory 
 
242
                # probing method
 
243
                this_id = inv.path2id(directory.raw_path)
 
244
                if this_id is None:
 
245
                    this_ie = None
 
246
                else:
 
247
                    this_ie = inv[this_id]
 
248
 
 
249
            for subf in os.listdir(abspath):
 
250
                # here we could use TreeDirectory rather than 
 
251
                # string concatenation.
 
252
                subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
 
253
                # TODO: is_control_filename is very slow. Make it faster. 
 
254
                # TreeDirectory.is_control_filename could also make this 
 
255
                # faster - its impossible for a non root dir to have a 
 
256
                # control file.
 
257
                if tree.is_control_filename(subp):
 
258
                    mutter("skip control directory %r", subp)
 
259
                elif subf in this_ie.children:
 
260
                    # recurse into this already versioned subdir.
 
261
                    dirs_to_add.append((FastPath(subp, subf), this_ie))
 
262
                else:
 
263
                    # user selection overrides ignoes
 
264
                    # ignore while selecting files - if we globbed in the
 
265
                    # outer loop we would ignore user files.
 
266
                    ignore_glob = tree.is_ignored(subp)
 
267
                    if ignore_glob is not None:
 
268
                        # mutter("skip ignored sub-file %r", subp)
 
269
                        if ignore_glob not in ignored:
 
270
                            ignored[ignore_glob] = []
 
271
                        ignored[ignore_glob].append(subp)
 
272
                    else:
 
273
                        #mutter("queue to add sub-file %r", subp)
 
274
                        dirs_to_add.append((FastPath(subp, subf), this_ie))
 
275
 
 
276
    if len(added) > 0 and save:
 
277
        tree._write_inventory(inv)
 
278
    return added, ignored
 
279
 
 
280
 
 
281
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
 
282
    """Add a new entry to the inventory and automatically add unversioned parents.
 
283
 
 
284
    :param inv: Inventory which will receive the new entry.
 
285
    :param parent_ie: Parent inventory entry if known, or None.  If
 
286
    None, the parent is looked up by name and used if present, otherwise
 
287
    it is recursively added.
 
288
    :param kind: Kind of new entry (file, directory, etc)
 
289
    :param action: callback(inv, parent_ie, path, kind); return ignored.
 
290
    :returns: A list of paths which have been added.
 
291
    """
 
292
    # Nothing to do if path is already versioned.
 
293
    # This is safe from infinite recursion because the tree root is
 
294
    # always versioned.
 
295
    if parent_ie is not None:
 
296
        # we have a parent ie already
 
297
        added = []
 
298
    else:
 
299
        # slower but does not need parent_ie
 
300
        if inv.has_filename(path.raw_path):
 
301
            return []
 
302
        # its really not there : add the parent
 
303
        # note that the dirname use leads to some extra str copying etc but as
 
304
        # there are a limited number of dirs we can be nested under, it should
 
305
        # generally find it very fast and not recurse after that.
 
306
        added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
 
307
        parent_id = inv.path2id(dirname(path.raw_path))
 
308
        parent_ie = inv[parent_id]
 
309
    __add_one(tree, inv, parent_ie, path, kind, action)
 
310
    return added + [path.raw_path]
 
311
 
 
312
 
 
313
def __add_one(tree, inv, parent_ie, path, kind, action):
 
314
    """Add a new entry to the inventory.
 
315
 
 
316
    :param inv: Inventory which will receive the new entry.
 
317
    :param parent_ie: Parent inventory entry.
 
318
    :param kind: Kind of new entry (file, directory, etc)
 
319
    :param action: callback(inv, parent_ie, path, kind); return ignored.
 
320
    :returns: None
 
321
    """
 
322
    action(inv, parent_ie, path, kind)
 
323
    entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id)
 
324
    inv.add(entry)