~bzr-pqm/bzr/bzr.dev

70 by mbp at sourcefrog
Prepare for smart recursive add.
1
# Copyright (C) 2005 Canonical Ltd
2
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
7
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
17
from os.path import dirname
18
19
import bzrlib.errors as errors
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
20
from bzrlib.inventory import InventoryEntry
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
21
from bzrlib.trace import mutter, note, warning
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
22
from bzrlib.errors import NotBranchError
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
23
from bzrlib.workingtree import is_control_file
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
24
import bzrlib.osutils
25
from bzrlib.workingtree import WorkingTree
70 by mbp at sourcefrog
Prepare for smart recursive add.
26
686 by Martin Pool
- glob expand add arguments on win32
27
def glob_expand_for_win32(file_list):
1185.23.2 by Aaron Bentley
win32 glob expansion fix from Belchenko
28
    if not file_list:
29
        return
686 by Martin Pool
- glob expand add arguments on win32
30
    import glob
31
    expanded_file_list = []
32
    for possible_glob in file_list:
33
        glob_files = glob.glob(possible_glob)
34
       
35
        if glob_files == []:
36
            # special case to let the normal code path handle
37
            # files that do not exists
38
            expanded_file_list.append(possible_glob)
39
        else:
40
            expanded_file_list += glob_files
41
    return expanded_file_list
42
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
43
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
44
def _prepare_file_list(file_list):
45
    """Prepare a file list for use by smart_add_*."""
46
    import sys
47
    if sys.platform == 'win32':
48
        file_list = glob_expand_for_win32(file_list)
49
    if not file_list:
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
50
        file_list = [u'.']
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
51
    file_list = list(file_list)
52
    return file_list
53
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
54
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
55
def add_action_null(inv, path, kind):
56
    """Absorb add actions and do nothing."""
57
    pass
58
59
def add_action_print(inv, path, kind):
60
    """Print a line to stdout for each file that would be added."""
61
    print "added", bzrlib.osutils.quotefn(path)
62
63
def add_action_add(inv, path, kind):
64
    """Add each file to the given inventory. Produce no output."""
65
    entry = inv.add_path(path, kind=kind)
66
    mutter("added %r kind %r file_id={%s}" % (path, kind, entry.file_id))
67
68
def add_action_add_and_print(inv, path, kind):
69
    """Add each file to the given inventory, and print a line to stdout."""
70
    add_action_add(inv, path, kind)
71
    add_action_print(inv, path, kind)
72
73
74
def smart_add(file_list, recurse=True, action=add_action_add):
598 by Martin Pool
doc
75
    """Add files to version, optionally recursing into directories.
70 by mbp at sourcefrog
Prepare for smart recursive add.
76
77
    This is designed more towards DWIM for humans than API simplicity.
78
    For the specific behaviour see the help for cmd_add().
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
79
80
    Returns the number of files added.
70 by mbp at sourcefrog
Prepare for smart recursive add.
81
    """
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
82
    file_list = _prepare_file_list(file_list)
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
83
    tree = WorkingTree.open_containing(file_list[0])[0]
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
84
    return smart_add_tree(tree, file_list, recurse, action)
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
85
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
86
def smart_add_tree(tree, file_list, recurse=True, action=add_action_add):
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
87
    """Add files to version, optionally recursing into directories.
88
89
    This is designed more towards DWIM for humans than API simplicity.
90
    For the specific behaviour see the help for cmd_add().
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
91
1508.1.11 by Robert Collins
Documentation.
92
    This calls reporter with each (path, kind, file_id) of added files.
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
93
94
    Returns the number of files added.
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
95
    """
1185.56.2 by Michael Ellerman
Raise NoSuchFile when someone tries to add a non-existant file.
96
    import os, errno
599 by Martin Pool
- better error reporting from smart_add
97
    from bzrlib.errors import BadFileKindError, ForbiddenFileError
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
98
    assert isinstance(recurse, bool)
99
1092.1.29 by Robert Collins
break smart_add into smart_add and smart_add_branch which will accept a branch parameter
100
    file_list = _prepare_file_list(file_list)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
101
    user_list = file_list[:]
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
102
    inv = tree.read_working_inventory()
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
103
    added = []
104
    ignored = {}
86 by mbp at sourcefrog
first cut at recursive add
105
70 by mbp at sourcefrog
Prepare for smart recursive add.
106
    for f in file_list:
1457.1.4 by Robert Collins
Branch.relpath has been moved to WorkingTree.relpath.
107
        rf = tree.relpath(f)
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
108
        af = tree.abspath(rf)
510 by Martin Pool
- fix add of files when standing in subdirectory
109
1185.56.2 by Michael Ellerman
Raise NoSuchFile when someone tries to add a non-existant file.
110
        try:
111
            kind = bzrlib.osutils.file_kind(af)
112
        except OSError, e:
113
            if hasattr(e, 'errno') and e.errno == errno.ENOENT:
114
                raise errors.NoSuchFile(rf)
115
            raise
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
116
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
117
        if not InventoryEntry.versionable_kind(kind):
599 by Martin Pool
- better error reporting from smart_add
118
            if f in user_list:
119
                raise BadFileKindError("cannot add %s of type %s" % (f, kind))
120
            else:
1128 by Martin Pool
- smart_add routine now doesn't print filenames directly, but rather
121
                warning("skipping %s (can't add file of kind '%s')", f, kind)
426 by Martin Pool
- Skip symlinks during recursive add (path from aaron)
122
                continue
123
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
124
        mutter("smart add of %r, abs=%r", f, af)
70 by mbp at sourcefrog
Prepare for smart recursive add.
125
        
1534.5.5 by Robert Collins
Move is_control_file into WorkingTree.is_control_filename and test.
126
        if tree.is_control_filename(af):
599 by Martin Pool
- better error reporting from smart_add
127
            raise ForbiddenFileError('cannot add control file %s' % f)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
128
            
86 by mbp at sourcefrog
first cut at recursive add
129
        versioned = (inv.path2id(rf) != None)
130
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
131
        if kind == 'directory':
132
            try:
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
133
                sub_branch = WorkingTree.open(af)
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
134
                sub_tree = True
135
            except NotBranchError:
136
                sub_tree = False
1185.1.53 by Robert Collins
raise a specific error on unsupported branches so that they can be distinguished from generic errors
137
            except errors.UnsupportedFormatError:
138
                sub_tree = True
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
139
        else:
140
            sub_tree = False
141
91 by mbp at sourcefrog
special handling of root directory for recursive add
142
        if rf == '':
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
143
            mutter("tree root doesn't need to be added")
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
144
            sub_tree = False
91 by mbp at sourcefrog
special handling of root directory for recursive add
145
        elif versioned:
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
146
            mutter("%r is already versioned", f)
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
147
        elif sub_tree:
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
148
            mutter("%r is a bzr tree", f)
70 by mbp at sourcefrog
Prepare for smart recursive add.
149
        else:
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
150
            added.extend(__add_one(tree, inv, rf, kind, action))
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
151
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
152
        if kind == 'directory' and recurse and not sub_tree:
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
153
            for subf in os.listdir(af):
1185.31.32 by John Arbash Meinel
Updated the bzr sourcecode to use bzrlib.osutils.pathjoin rather than os.path.join to enforce internal use of / instead of \
154
                subp = bzrlib.osutils.pathjoin(rf, subf)
1534.5.5 by Robert Collins
Move is_control_file into WorkingTree.is_control_filename and test.
155
                if tree.is_control_filename(subp):
1185.31.4 by John Arbash Meinel
Fixing mutter() calls to not have to do string processing.
156
                    mutter("skip control directory %r", subp)
87 by mbp at sourcefrog
- clean up smart_add code, and make it commit the inventory
157
                else:
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
158
                    ignore_glob = tree.is_ignored(subp)
159
                    if ignore_glob is not None:
160
                        mutter("skip ignored sub-file %r", subp)
161
                        if ignore_glob not in ignored:
162
                            ignored[ignore_glob] = []
163
                        ignored[ignore_glob].append(subp)
164
                    else:
165
                        mutter("queue to add sub-file %r", subp)
166
                        file_list.append(tree.abspath(subp))
167
168
169
    mutter('added %d entries', len(added))
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
170
    
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
171
    if len(added) > 0:
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
172
        tree._write_inventory(inv)
1159 by Martin Pool
- clean up parameters to smart_add and smart_add_branch
173
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
174
    return added, ignored
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
175
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
176
def __add_one(tree, inv, path, kind, action):
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
177
    """Add a file or directory, automatically add unversioned parents."""
178
179
    # Nothing to do if path is already versioned.
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
180
    # This is safe from infinite recursion because the tree root is
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
181
    # always versioned.
182
    if inv.path2id(path) != None:
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
183
        return []
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
184
185
    # add parent
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
186
    added = __add_one(tree, inv, dirname(path), 'directory', action)
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
187
    action(inv, path, kind)
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
188
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
189
    return added + [path]