~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/add.py

  • Committer: Martin Pool
  • Date: 2006-06-15 05:36:34 UTC
  • mto: This revision was merged to the branch mainline in revision 1797.
  • Revision ID: mbp@sourcefrog.net-20060615053634-4fd52ba691855659
Clean up many exception classes.

Errors indicating a user error are now shown with is_user_error on the
exception; use this rather than hardcoding a list of exceptions that should be
handled this way.

Exceptions now inherit from BzrNewException where possible to use consistent
formatting method.

Remove rather obsolete docstring test on Branch.missing_revisions.

Remove dead code from find_merge_base.


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
 
import os, sys
18
 
import bzrlib
19
 
 
20
 
from osutils import quotefn, appendpath
21
 
from errors import bailout
22
 
from trace import mutter, note
23
 
 
24
 
def smart_add(file_list, verbose=False, recurse=True):
25
 
    """Add files to version, optionall recursing into directories.
26
 
 
27
 
    This is designed more towards DWIM for humans than API simplicity.
28
 
    For the specific behaviour see the help for cmd_add().
29
 
    """
30
 
    assert file_list
31
 
    assert not isinstance(file_list, basestring)
32
 
    b = bzrlib.branch.Branch(file_list[0], find_root=True)
33
 
    inv = b.read_working_inventory()
34
 
    tree = b.working_tree()
35
 
    count = 0
36
 
 
37
 
    for f in file_list:
38
 
        rf = b.relpath(f)
39
 
        af = b.abspath(rf)
40
 
 
41
 
        ## TODO: It's OK to add root but only in recursive mode
42
 
 
43
 
        bzrlib.mutter("smart add of %r" % f)
44
 
        
45
 
        if bzrlib.branch.is_control_file(af):
46
 
            bailout("cannot add control file %r" % af)
47
 
 
48
 
        kind = bzrlib.osutils.file_kind(f)
49
 
 
50
 
        if kind != 'file' and kind != 'directory':
51
 
            bailout("can't add file of kind %r" % kind)
52
 
            
53
 
        versioned = (inv.path2id(rf) != None)
54
 
 
55
 
        if rf == '':
56
 
            mutter("branch root doesn't need to be added")
 
17
from os.path import dirname
 
18
 
 
19
import bzrlib.errors as errors
 
20
from bzrlib.inventory import InventoryEntry
 
21
from bzrlib.trace import mutter, note, warning
 
22
from bzrlib.errors import NotBranchError
 
23
import bzrlib.osutils
 
24
from bzrlib.workingtree import WorkingTree
 
25
 
 
26
def glob_expand_for_win32(file_list):
 
27
    if not file_list:
 
28
        return
 
29
    import glob
 
30
    expanded_file_list = []
 
31
    for possible_glob in file_list:
 
32
        glob_files = glob.glob(possible_glob)
 
33
       
 
34
        if glob_files == []:
 
35
            # special case to let the normal code path handle
 
36
            # files that do not exists
 
37
            expanded_file_list.append(possible_glob)
 
38
        else:
 
39
            expanded_file_list += glob_files
 
40
    return expanded_file_list
 
41
 
 
42
 
 
43
def _prepare_file_list(file_list):
 
44
    """Prepare a file list for use by smart_add_*."""
 
45
    import sys
 
46
    if sys.platform == 'win32':
 
47
        file_list = glob_expand_for_win32(file_list)
 
48
    if not file_list:
 
49
        file_list = [u'.']
 
50
    file_list = list(file_list)
 
51
    return file_list
 
52
 
 
53
 
 
54
def add_action_null(inv, parent_ie, path, kind):
 
55
    """Absorb add actions and do nothing."""
 
56
    pass
 
57
 
 
58
 
 
59
def add_action_print(inv, parent_ie, path, kind):
 
60
    """Print a line to stdout for each file that would be added."""
 
61
    print "added", bzrlib.osutils.quotefn(path)
 
62
 
 
63
 
 
64
def add_action_add(inv, parent_ie, path, kind):
 
65
    """Add each file to the given inventory. Produce no output."""
 
66
    if parent_ie is not None:
 
67
        entry = bzrlib.inventory.make_entry(
 
68
            kind, bzrlib.osutils.basename(path),  parent_ie.file_id)
 
69
        inv.add(entry)
 
70
    else:
 
71
        entry = inv.add_path(path, kind=kind)
 
72
    # mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
 
73
 
 
74
 
 
75
def add_action_add_and_print(inv, parent_ie, path, kind):
 
76
    """Add each file to the given inventory, and print a line to stdout."""
 
77
    add_action_add(inv, parent_ie, path, kind)
 
78
    add_action_print(inv, parent_ie, path, kind)
 
79
 
 
80
 
 
81
def smart_add(file_list, recurse=True, action=add_action_add):
 
82
    """Add files to version, optionally recursing into directories.
 
83
 
 
84
    This is designed more towards DWIM for humans than API simplicity.
 
85
    For the specific behaviour see the help for cmd_add().
 
86
 
 
87
    Returns the number of files added.
 
88
    """
 
89
    file_list = _prepare_file_list(file_list)
 
90
    tree = WorkingTree.open_containing(file_list[0])[0]
 
91
    return smart_add_tree(tree, file_list, recurse, action)
 
92
 
 
93
 
 
94
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
 
95
    """Add files to version, optionally recursing into directories.
 
96
 
 
97
    This is designed more towards DWIM for humans than API simplicity.
 
98
    For the specific behaviour see the help for cmd_add().
 
99
 
 
100
    This calls reporter with each (path, kind, file_id) of added files.
 
101
 
 
102
    Returns the number of files added.
 
103
    """
 
104
    import os, errno
 
105
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
 
106
    assert isinstance(recurse, bool)
 
107
    
 
108
    prepared_list = _prepare_file_list(file_list)
 
109
    mutter("smart add of %r, originally %r", prepared_list, file_list)
 
110
    inv = tree.read_working_inventory()
 
111
    added = []
 
112
    ignored = {}
 
113
    user_files = set()
 
114
    files_to_add = []
 
115
 
 
116
    # validate user file paths and convert all paths to tree 
 
117
    # relative : its cheaper to make a tree relative path an abspath
 
118
    # than to convert an abspath to tree relative.
 
119
    for filepath in prepared_list:
 
120
        rf = tree.relpath(filepath)
 
121
        user_files.add(rf)
 
122
        files_to_add.append((rf, None))
 
123
        # validate user parameters. Our recursive code avoids adding new files
 
124
        # that need such validation 
 
125
        if tree.is_control_filename(rf):
 
126
            raise ForbiddenFileError('cannot add control file %s' % filepath)
 
127
 
 
128
    for filepath, parent_ie in files_to_add:
 
129
        # filepath is tree-relative
 
130
        abspath = tree.abspath(filepath)
 
131
 
 
132
        # find the kind of the path being added. This is not
 
133
        # currently determined when we list directories 
 
134
        # recursively, but in theory we can determine while 
 
135
        # doing the directory listing on *some* platformans.
 
136
        # TODO: a safe, portable, clean interface which will 
 
137
        # be faster than os.listdir() + stat. Specifically,
 
138
        # readdir - dirent.d_type supplies the file type when
 
139
        # it is defined. (Apparently Mac OSX has the field but
 
140
        # does not fill it in ?!) Robert C, Martin P.
 
141
        try:
 
142
            kind = bzrlib.osutils.file_kind(abspath)
 
143
        except OSError, e:
 
144
            if hasattr(e, 'errno') and e.errno == errno.ENOENT:
 
145
                raise errors.NoSuchFile(abspath)
 
146
            raise
 
147
 
 
148
        # we need to call this to determine the inventory kind to create.
 
149
        if not InventoryEntry.versionable_kind(kind):
 
150
            if filepath in user_files:
 
151
                raise BadFileKindError("cannot add %s of type %s" % (abspath, kind))
 
152
            else:
 
153
                warning("skipping %s (can't add file of kind '%s')", abspath, kind)
 
154
                continue
 
155
 
 
156
        if parent_ie is not None:
 
157
            versioned = bzrlib.osutils.basename(filepath) in parent_ie.children
 
158
        else:
 
159
            # without the parent ie, use the relatively slower inventory 
 
160
            # probing method
 
161
            versioned = inv.has_filename(filepath)
 
162
 
 
163
        if kind == 'directory':
 
164
            try:
 
165
                sub_branch = bzrlib.bzrdir.BzrDir.open(abspath)
 
166
                sub_tree = True
 
167
            except NotBranchError:
 
168
                sub_tree = False
 
169
            except errors.UnsupportedFormatError:
 
170
                sub_tree = True
 
171
        else:
 
172
            sub_tree = False
 
173
 
 
174
        if filepath == '':
 
175
            # mutter("tree root doesn't need to be added")
 
176
            sub_tree = False
57
177
        elif versioned:
58
 
            mutter("%r is already versioned" % f)
59
 
        else:
60
 
            file_id = bzrlib.branch.gen_file_id(rf)
61
 
            inv.add_path(rf, kind=kind, file_id=file_id)
62
 
            bzrlib.mutter("added %r kind %r file_id={%s}" % (rf, kind, file_id))
63
 
            count += 1 
64
 
            if verbose:
65
 
                bzrlib.textui.show_status('A', kind, quotefn(f))
66
 
 
67
 
        if kind == 'directory' and recurse:
68
 
            for subf in os.listdir(af):
69
 
                subp = appendpath(rf, subf)
70
 
                if subf == bzrlib.BZRDIR:
71
 
                    mutter("skip control directory %r" % subp)
72
 
                elif tree.is_ignored(subp):
73
 
                    mutter("skip ignored sub-file %r" % subp)
74
 
                else:
75
 
                    mutter("queue to add sub-file %r" % (subp))
76
 
                    file_list.append(subp)
77
 
 
78
 
    if count > 0:
79
 
        if verbose:
80
 
            note('added %d' % count)
81
 
        b._write_inventory(inv)
 
178
            pass
 
179
            # mutter("%r is already versioned", abspath)
 
180
        elif sub_tree:
 
181
            mutter("%r is a nested bzr tree", abspath)
 
182
        else:
 
183
            added.extend(__add_one(tree, inv, parent_ie, filepath, kind, action))
 
184
 
 
185
        if kind == 'directory' and recurse and not sub_tree:
 
186
            try:
 
187
                if parent_ie is not None:
 
188
                    # must be present:
 
189
                    this_ie = parent_ie.children[bzrlib.osutils.basename(filepath)]
 
190
                else:
 
191
                    # without the parent ie, use the relatively slower inventory 
 
192
                    # probing method
 
193
                    this_id = inv.path2id(filepath)
 
194
                    if this_id is None:
 
195
                        this_ie = None
 
196
                    else:
 
197
                        this_ie = inv[this_id]
 
198
            except KeyError:
 
199
                this_ie = None
 
200
 
 
201
            for subf in os.listdir(abspath):
 
202
                # here we could use TreeDirectory rather than 
 
203
                # string concatenation.
 
204
                subp = bzrlib.osutils.pathjoin(filepath, subf)
 
205
                # TODO: is_control_filename is very slow. Make it faster. 
 
206
                # TreeDirectory.is_control_filename could also make this 
 
207
                # faster - its impossible for a non root dir to have a 
 
208
                # control file.
 
209
                if tree.is_control_filename(subp):
 
210
                    mutter("skip control directory %r", subp)
 
211
                else:
 
212
                    # ignore while selecting files - if we globbed in the
 
213
                    # outer loop we would ignore user files.
 
214
                    ignore_glob = tree.is_ignored(subp)
 
215
                    if ignore_glob is not None:
 
216
                        # mutter("skip ignored sub-file %r", subp)
 
217
                        if ignore_glob not in ignored:
 
218
                            ignored[ignore_glob] = []
 
219
                        ignored[ignore_glob].append(subp)
 
220
                    else:
 
221
                        #mutter("queue to add sub-file %r", subp)
 
222
                        files_to_add.append((subp, this_ie))
 
223
 
 
224
    if len(added) > 0:
 
225
        tree._write_inventory(inv)
 
226
    return added, ignored
 
227
 
 
228
 
 
229
def __add_one(tree, inv, parent_ie, path, kind, action):
 
230
    """Add a new entry to the inventory and automatically add unversioned parents.
 
231
 
 
232
    Actual adding of the entry is delegated to the action callback.
 
233
 
 
234
    :param inv: Inventory which will receive the new entry.
 
235
    :param parent_ie: Parent inventory entry if known, or None.  If
 
236
    None, the parent is looked up by name and used if present, otherwise
 
237
    it is recursively added.
 
238
    :param kind: Kind of new entry (file, directory, etc)
 
239
    :param action: callback(inv, parent_ie, path, kind); return ignored.
 
240
    :returns: A list of paths which have been added.
 
241
    """
 
242
 
 
243
    # Nothing to do if path is already versioned.
 
244
    # This is safe from infinite recursion because the tree root is
 
245
    # always versioned.
 
246
    if parent_ie is not None:
 
247
        # we have a parent ie already
 
248
        added = []
 
249
    else:
 
250
        # slower but does not need parent_ie
 
251
        if inv.has_filename(path):
 
252
            return []
 
253
        # add parent
 
254
        added = __add_one(tree, inv, None, dirname(path), 'directory', action)
 
255
        parent_id = inv.path2id(dirname(path))
 
256
        if parent_id is not None:
 
257
            parent_ie = inv[inv.path2id(dirname(path))]
 
258
        else:
 
259
            parent_ie = None
 
260
    action(inv, parent_ie, path, kind)
 
261
 
 
262
    return added + [path]