~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: John Arbash Meinel
  • Date: 2005-09-15 21:35:53 UTC
  • mfrom: (907.1.57)
  • mto: (1393.2.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050915213552-a6c83a5ef1e20897
(broken) Transport work is merged in. Tests do not pass yet.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
import errno
18
 
import os
19
 
from os.path import dirname
20
 
import sys
21
 
 
22
 
import bzrlib.errors as errors
23
 
from bzrlib.inventory import InventoryEntry
24
17
from bzrlib.trace import mutter, note, warning
25
18
from bzrlib.errors import NotBranchError
26
 
import bzrlib.osutils
27
 
from bzrlib.workingtree import WorkingTree
28
 
 
 
19
from bzrlib.branch import Branch
 
20
from bzrlib.osutils import quotefn
 
21
from os.path import dirname
29
22
 
30
23
def glob_expand_for_win32(file_list):
31
 
    if not file_list:
32
 
        return
33
24
    import glob
 
25
    
34
26
    expanded_file_list = []
35
27
    for possible_glob in file_list:
36
28
        glob_files = glob.glob(possible_glob)
44
36
    return expanded_file_list
45
37
 
46
38
 
 
39
def add_reporter_null(path, kind, entry):
 
40
    """Absorb add reports and do nothing."""
 
41
    pass
 
42
 
 
43
def add_reporter_print(path, kind, entry):
 
44
    """Print a line to stdout for each file that's added."""
 
45
    print "added", quotefn(path)
 
46
    
47
47
def _prepare_file_list(file_list):
48
48
    """Prepare a file list for use by smart_add_*."""
 
49
    import sys
49
50
    if sys.platform == 'win32':
50
51
        file_list = glob_expand_for_win32(file_list)
51
52
    if not file_list:
52
 
        file_list = [u'.']
 
53
        file_list = ['.']
53
54
    file_list = list(file_list)
54
55
    return file_list
55
56
 
56
57
 
57
 
class AddAction(object):
58
 
    """A class which defines what action to take when adding a file."""
59
 
 
60
 
    def __init__(self, to_file=None, should_print=None):
61
 
        self._to_file = to_file
62
 
        if to_file is None:
63
 
            self._to_file = sys.stdout
64
 
        self.should_print = False
65
 
        if should_print is not None:
66
 
            self.should_print = should_print
67
 
 
68
 
    def __call__(self, inv, parent_ie, path, kind, _quote=bzrlib.osutils.quotefn):
69
 
        """Add path to inventory.
70
 
 
71
 
        The default action does nothing.
72
 
 
73
 
        :param inv: The inventory we are working with.
74
 
        :param path: The FastPath being added
75
 
        :param kind: The kind of the object being added.
76
 
        """
77
 
        if self.should_print:
78
 
            self._to_file.write('added %s\n' % _quote(path.raw_path))
79
 
        return None
80
 
 
81
 
 
82
 
class AddFromBaseAction(AddAction):
83
 
    """This class will try to extract file ids from another tree."""
84
 
 
85
 
    def __init__(self, base_tree, base_path, to_file=None, should_print=None):
86
 
        super(AddFromBaseAction, self).__init__(to_file=to_file,
87
 
                                                should_print=should_print)
88
 
        self.base_tree = base_tree
89
 
        self.base_path = base_path
90
 
 
91
 
    def __call__(self, inv, parent_ie, path, kind):
92
 
        # Place the parent call
93
 
        # Now check to see if we can extract an id for this file
94
 
        file_id, base_path = self._get_base_file_id(path, parent_ie)
95
 
        if file_id is not None:
96
 
            if self.should_print:
97
 
                self._to_file.write('added %s w/ file id from %s\n'
98
 
                                    % (path.raw_path, base_path))
99
 
        else:
100
 
            # we aren't doing anything special, so let the default
101
 
            # reporter happen
102
 
            file_id = super(AddFromBaseAction, self).__call__(
103
 
                        inv, parent_ie, path, kind)
104
 
        return file_id
105
 
 
106
 
    def _get_base_file_id(self, path, parent_ie):
107
 
        """Look for a file id in the base branch.
108
 
 
109
 
        First, if the base tree has the parent directory,
110
 
        we look for a file with the same name in that directory.
111
 
        Else, we look for an entry in the base tree with the same path.
112
 
        """
113
 
 
114
 
        if (parent_ie.file_id in self.base_tree):
115
 
            base_parent_ie = self.base_tree.inventory[parent_ie.file_id]
116
 
            base_child_ie = base_parent_ie.children.get(path.base_path)
117
 
            if base_child_ie is not None:
118
 
                return (base_child_ie.file_id,
119
 
                        self.base_tree.id2path(base_child_ie.file_id))
120
 
        full_base_path = bzrlib.osutils.pathjoin(self.base_path, path.raw_path)
121
 
        # This may return None, but it is our last attempt
122
 
        return self.base_tree.path2id(full_base_path), full_base_path
123
 
 
124
 
 
125
 
# TODO: jam 20050105 These could be used for compatibility
126
 
#       however, they bind against the current stdout, not the
127
 
#       one which exists at the time they are called, so they
128
 
#       don't work for the test suite.
129
 
# deprecated
130
 
add_action_add = AddAction()
131
 
add_action_null = add_action_add
132
 
add_action_add_and_print = AddAction(should_print=True)
133
 
add_action_print = add_action_add_and_print
134
 
 
135
 
 
136
 
def smart_add(file_list, recurse=True, action=None, save=True):
 
58
def smart_add(file_list, recurse=True, reporter=add_reporter_null):
137
59
    """Add files to version, optionally recursing into directories.
138
60
 
139
61
    This is designed more towards DWIM for humans than API simplicity.
140
62
    For the specific behaviour see the help for cmd_add().
141
63
 
142
64
    Returns the number of files added.
143
 
    Please see smart_add_tree for more detail.
144
65
    """
145
66
    file_list = _prepare_file_list(file_list)
146
 
    tree = WorkingTree.open_containing(file_list[0])[0]
147
 
    return smart_add_tree(tree, file_list, recurse, action=action, save=save)
148
 
 
149
 
 
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
 
 
170
 
def smart_add_tree(tree, file_list, recurse=True, action=None, save=True):
 
67
    b = Branch(file_list[0], find_root=True)
 
68
    return smart_add_branch(b, file_list, recurse, reporter)
 
69
 
 
70
        
 
71
def smart_add_branch(branch, file_list, recurse=True, reporter=add_reporter_null):
171
72
    """Add files to version, optionally recursing into directories.
172
73
 
173
74
    This is designed more towards DWIM for humans than API simplicity.
174
75
    For the specific behaviour see the help for cmd_add().
175
76
 
176
 
    This calls reporter with each (path, kind, file_id) of added files.
 
77
    This yields a sequence of (path, kind, file_id) for added files.
177
78
 
178
79
    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
80
    """
 
81
    import os
 
82
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
 
83
    import bzrlib.branch
 
84
 
186
85
    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)
 
86
 
 
87
    file_list = _prepare_file_list(file_list)
 
88
    user_list = file_list[:]
 
89
    inv = branch.read_working_inventory()
 
90
    tree = branch.working_tree()
 
91
    count = 0
 
92
 
 
93
    for f in file_list:
 
94
        rf = branch.relpath(f)
 
95
        af = branch.abspath(rf)
 
96
 
 
97
        kind = bzrlib.osutils.file_kind(af)
 
98
 
 
99
        if kind != 'file' and kind != 'directory':
 
100
            if f in user_list:
 
101
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
 
102
            else:
 
103
                warning("skipping %s (can't add file of kind '%s')", f, kind)
 
104
                continue
 
105
 
 
106
        mutter("smart add of %r, abs=%r" % (f, af))
207
107
        
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)
 
108
        if bzrlib.branch.is_control_file(af):
 
109
            raise ForbiddenFileError('cannot add control file %s' % f)
 
110
            
 
111
        versioned = (inv.path2id(rf) != None)
262
112
 
263
113
        if kind == 'directory':
264
114
            try:
265
 
                sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
 
115
                sub_branch = Branch(af, find_root=False)
266
116
                sub_tree = True
267
117
            except NotBranchError:
268
118
                sub_tree = False
269
 
            except errors.UnsupportedFormatError:
270
 
                sub_tree = True
271
119
        else:
272
120
            sub_tree = False
273
121
 
274
 
        if directory.raw_path == '':
275
 
            # mutter("tree root doesn't need to be added")
 
122
        if rf == '':
 
123
            mutter("branch root doesn't need to be added")
276
124
            sub_tree = False
277
125
        elif versioned:
278
 
            pass
279
 
            # mutter("%r is already versioned", abspath)
 
126
            mutter("%r is already versioned" % f)
280
127
        elif sub_tree:
281
 
            mutter("%r is a nested bzr tree", abspath)
 
128
            mutter("%r is a bzr tree" %f)
282
129
        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 sorted(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
 
    """
 
130
            count += __add_one(branch, inv, rf, kind, reporter)
 
131
 
 
132
        if kind == 'directory' and recurse and not sub_tree:
 
133
            for subf in os.listdir(af):
 
134
                subp = os.path.join(rf, subf)
 
135
                if subf == bzrlib.BZRDIR:
 
136
                    mutter("skip control directory %r" % subp)
 
137
                elif tree.is_ignored(subp):
 
138
                    mutter("skip ignored sub-file %r" % subp)
 
139
                else:
 
140
                    mutter("queue to add sub-file %r" % subp)
 
141
                    file_list.append(branch.abspath(subp))
 
142
 
 
143
 
 
144
    mutter('added %d entries', count)
 
145
    
 
146
    if count > 0:
 
147
        branch._write_inventory(inv)
 
148
 
 
149
    return count
 
150
 
 
151
def __add_one(branch, inv, path, kind, reporter):
 
152
    """Add a file or directory, automatically add unversioned parents."""
 
153
 
340
154
    # Nothing to do if path is already versioned.
341
 
    # This is safe from infinite recursion because the tree root is
 
155
    # This is safe from infinite recursion because the branch root is
342
156
    # 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)
 
157
    if inv.path2id(path) != None:
 
158
        return 0
 
159
 
 
160
    # add parent
 
161
    count = __add_one(branch, inv, dirname(path), 'directory', reporter)
 
162
 
 
163
    entry = inv.add_path(path, kind=kind)
 
164
    mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
 
165
    reporter(path, kind, entry)
 
166
 
 
167
    return count + 1