~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-16 22:35:21 UTC
  • mto: This revision was merged to the branch mainline in revision 1942.
  • Revision ID: john@arbash-meinel.com-20060816223521-73357694d4b7df0b
One field was incorrect, need text_sha1 not text_size

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
112
133
add_action_print = add_action_add_and_print
113
134
 
114
135
 
115
 
@deprecated_function(zero_eighteen)
116
136
def smart_add(file_list, recurse=True, action=None, save=True):
117
137
    """Add files to version, optionally recursing into directories.
118
138
 
120
140
    For the specific behaviour see the help for cmd_add().
121
141
 
122
142
    Returns the number of files added.
123
 
    Deprecated in 0.18. Please use MutableTree.smart_add.
 
143
    Please see smart_add_tree for more detail.
124
144
    """
 
145
    file_list = _prepare_file_list(file_list)
125
146
    tree = WorkingTree.open_containing(file_list[0])[0]
126
147
    return smart_add_tree(tree, file_list, recurse, action=action, save=save)
127
148
 
128
149
 
129
 
@deprecated_function(zero_eighteen)
 
150
class FastPath(object):
 
151
    """A path object with fast accessors for things like basename."""
 
152
 
 
153
    __slots__ = ['raw_path', 'base_path']
 
154
 
 
155
    def __init__(self, path, base_path=None):
 
156
        """Construct a FastPath from path."""
 
157
        if base_path is None:
 
158
            self.base_path = bzrlib.osutils.basename(path)
 
159
        else:
 
160
            self.base_path = base_path
 
161
        self.raw_path = path
 
162
 
 
163
    def __cmp__(self, other):
 
164
        return cmp(self.raw_path, other.raw_path)
 
165
 
 
166
    def __hash__(self):
 
167
        return hash(self.raw_path)
 
168
 
 
169
 
130
170
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
 
 
 
171
    """Add files to version, optionally recursing into directories.
 
172
 
 
173
    This is designed more towards DWIM for humans than API simplicity.
 
174
    For the specific behaviour see the help for cmd_add().
 
175
 
 
176
    This calls reporter with each (path, kind, file_id) of added files.
 
177
 
 
178
    Returns the number of files added.
 
179
    
 
180
    :param save: Save the inventory after completing the adds. If False this
 
181
    provides dry-run functionality by doing the add and not saving the
 
182
    inventory.  Note that the modified inventory is left in place, allowing 
 
183
    further dry-run tasks to take place. To restore the original inventory
 
184
    call tree.read_working_inventory().
 
185
    """
 
186
    assert isinstance(recurse, bool)
 
187
    if action is None:
 
188
        action = AddAction()
 
189
    
 
190
    prepared_list = _prepare_file_list(file_list)
 
191
    mutter("smart add of %r, originally %r", prepared_list, file_list)
 
192
    inv = tree.read_working_inventory()
 
193
    added = []
 
194
    ignored = {}
 
195
    dirs_to_add = []
 
196
    user_dirs = set()
 
197
 
 
198
    # validate user file paths and convert all paths to tree 
 
199
    # relative : its cheaper to make a tree relative path an abspath
 
200
    # than to convert an abspath to tree relative.
 
201
    for filepath in prepared_list:
 
202
        rf = FastPath(tree.relpath(filepath))
 
203
        # validate user parameters. Our recursive code avoids adding new files
 
204
        # that need such validation 
 
205
        if tree.is_control_filename(rf.raw_path):
 
206
            raise errors.ForbiddenControlFileError(filename=rf)
 
207
        
 
208
        abspath = tree.abspath(rf.raw_path)
 
209
        kind = bzrlib.osutils.file_kind(abspath)
 
210
        if kind == 'directory':
 
211
            # schedule the dir for scanning
 
212
            user_dirs.add(rf)
 
213
        else:
 
214
            if not InventoryEntry.versionable_kind(kind):
 
215
                raise errors.BadFileKindError(filename=abspath, kind=kind)
 
216
        # ensure the named path is added, so that ignore rules in the later directory
 
217
        # walk dont skip it.
 
218
        # we dont have a parent ie known yet.: use the relatively slower inventory 
 
219
        # probing method
 
220
        versioned = inv.has_filename(rf.raw_path)
 
221
        if versioned:
 
222
            continue
 
223
        added.extend(__add_one_and_parent(tree, inv, None, rf, kind, action))
 
224
 
 
225
    if not recurse:
 
226
        # no need to walk any directories at all.
 
227
        if len(added) > 0 and save:
 
228
            tree._write_inventory(inv)
 
229
        return added, ignored
 
230
 
 
231
    # only walk the minimal parents needed: we have user_dirs to override
 
232
    # ignores.
 
233
    prev_dir = None
 
234
 
 
235
    is_inside = bzrlib.osutils.is_inside_or_parent_of_any
 
236
    for path in sorted(user_dirs):
 
237
        if (prev_dir is None or not is_inside([prev_dir], path.raw_path)):
 
238
            dirs_to_add.append((path, None))
 
239
        prev_dir = path.raw_path
 
240
 
 
241
    # this will eventually be *just* directories, right now it starts off with 
 
242
    # just directories.
 
243
    for directory, parent_ie in dirs_to_add:
 
244
        # directory is tree-relative
 
245
        abspath = tree.abspath(directory.raw_path)
 
246
 
 
247
        # get the contents of this directory.
 
248
 
 
249
        # find the kind of the path being added.
 
250
        kind = bzrlib.osutils.file_kind(abspath)
 
251
 
 
252
        if not InventoryEntry.versionable_kind(kind):
 
253
            warning("skipping %s (can't add file of kind '%s')", abspath, kind)
 
254
            continue
 
255
 
 
256
        if parent_ie is not None:
 
257
            versioned = directory.base_path in parent_ie.children
 
258
        else:
 
259
            # without the parent ie, use the relatively slower inventory 
 
260
            # probing method
 
261
            versioned = inv.has_filename(directory.raw_path)
 
262
 
 
263
        if kind == 'directory':
 
264
            try:
 
265
                sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
 
266
                sub_tree = True
 
267
            except NotBranchError:
 
268
                sub_tree = False
 
269
            except errors.UnsupportedFormatError:
 
270
                sub_tree = True
 
271
        else:
 
272
            sub_tree = False
 
273
 
 
274
        if directory.raw_path == '':
 
275
            # mutter("tree root doesn't need to be added")
 
276
            sub_tree = False
 
277
        elif versioned:
 
278
            pass
 
279
            # mutter("%r is already versioned", abspath)
 
280
        elif sub_tree:
 
281
            mutter("%r is a nested bzr tree", abspath)
 
282
        else:
 
283
            __add_one(tree, inv, parent_ie, directory, kind, action)
 
284
            added.append(directory.raw_path)
 
285
 
 
286
        if kind == 'directory' and not sub_tree:
 
287
            if parent_ie is not None:
 
288
                # must be present:
 
289
                this_ie = parent_ie.children[directory.base_path]
 
290
            else:
 
291
                # without the parent ie, use the relatively slower inventory 
 
292
                # probing method
 
293
                this_id = inv.path2id(directory.raw_path)
 
294
                if this_id is None:
 
295
                    this_ie = None
 
296
                else:
 
297
                    this_ie = inv[this_id]
 
298
 
 
299
            for subf in os.listdir(abspath):
 
300
                # here we could use TreeDirectory rather than 
 
301
                # string concatenation.
 
302
                subp = bzrlib.osutils.pathjoin(directory.raw_path, subf)
 
303
                # TODO: is_control_filename is very slow. Make it faster. 
 
304
                # TreeDirectory.is_control_filename could also make this 
 
305
                # faster - its impossible for a non root dir to have a 
 
306
                # control file.
 
307
                if tree.is_control_filename(subp):
 
308
                    mutter("skip control directory %r", subp)
 
309
                elif subf in this_ie.children:
 
310
                    # recurse into this already versioned subdir.
 
311
                    dirs_to_add.append((FastPath(subp, subf), this_ie))
 
312
                else:
 
313
                    # user selection overrides ignoes
 
314
                    # ignore while selecting files - if we globbed in the
 
315
                    # outer loop we would ignore user files.
 
316
                    ignore_glob = tree.is_ignored(subp)
 
317
                    if ignore_glob is not None:
 
318
                        # mutter("skip ignored sub-file %r", subp)
 
319
                        ignored.setdefault(ignore_glob, []).append(subp)
 
320
                    else:
 
321
                        #mutter("queue to add sub-file %r", subp)
 
322
                        dirs_to_add.append((FastPath(subp, subf), this_ie))
 
323
 
 
324
    if len(added) > 0 and save:
 
325
        tree._write_inventory(inv)
 
326
    return added, ignored
 
327
 
 
328
 
 
329
def __add_one_and_parent(tree, inv, parent_ie, path, kind, action):
 
330
    """Add a new entry to the inventory and automatically add unversioned parents.
 
331
 
 
332
    :param inv: Inventory which will receive the new entry.
 
333
    :param parent_ie: Parent inventory entry if known, or None.  If
 
334
    None, the parent is looked up by name and used if present, otherwise
 
335
    it is recursively added.
 
336
    :param kind: Kind of new entry (file, directory, etc)
 
337
    :param action: callback(inv, parent_ie, path, kind); return ignored.
 
338
    :returns: A list of paths which have been added.
 
339
    """
 
340
    # Nothing to do if path is already versioned.
 
341
    # This is safe from infinite recursion because the tree root is
 
342
    # always versioned.
 
343
    if parent_ie is not None:
 
344
        # we have a parent ie already
 
345
        added = []
 
346
    else:
 
347
        # slower but does not need parent_ie
 
348
        if inv.has_filename(path.raw_path):
 
349
            return []
 
350
        # its really not there : add the parent
 
351
        # note that the dirname use leads to some extra str copying etc but as
 
352
        # there are a limited number of dirs we can be nested under, it should
 
353
        # generally find it very fast and not recurse after that.
 
354
        added = __add_one_and_parent(tree, inv, None, FastPath(dirname(path.raw_path)), 'directory', action)
 
355
        parent_id = inv.path2id(dirname(path.raw_path))
 
356
        parent_ie = inv[parent_id]
 
357
    __add_one(tree, inv, parent_ie, path, kind, action)
 
358
    return added + [path.raw_path]
 
359
 
 
360
 
 
361
def __add_one(tree, inv, parent_ie, path, kind, action):
 
362
    """Add a new entry to the inventory.
 
363
 
 
364
    :param inv: Inventory which will receive the new entry.
 
365
    :param parent_ie: Parent inventory entry.
 
366
    :param kind: Kind of new entry (file, directory, etc)
 
367
    :param action: callback(inv, parent_ie, path, kind); return a file_id 
 
368
        or None to generate a new file id
 
369
    :returns: None
 
370
    """
 
371
    file_id = action(inv, parent_ie, path, kind)
 
372
    entry = bzrlib.inventory.make_entry(kind, path.base_path, parent_ie.file_id,
 
373
                                        file_id=file_id)
 
374
    inv.add(entry)